4 * DEBUG: section 33 Client-side Routines
5 * AUTHOR: Duane Wessels
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
10 * Squid is the result of efforts by numerous individuals from
11 * the Internet community; see the CONTRIBUTORS file for full
12 * details. Many organizations have provided support for Squid's
13 * development; see the SPONSORS file for full details. Squid is
14 * Copyrighted (C) 2001 by the Regents of the University of
15 * California; see the COPYRIGHT file for full details. Squid
16 * incorporates software developed and/or copyrighted by other
17 * sources; see the CREDITS file for full details.
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
36 \defgroup ClientSide Client-Side Logics
38 \section cserrors Errors and client side
40 \par Problem the first:
41 * the store entry is no longer authoritative on the
42 * reply status. EBITTEST (E_ABORT) is no longer a valid test outside
43 * of client_side_reply.c.
44 * Problem the second: resources are wasted if we delay in cleaning up.
45 * Problem the third we can't depend on a connection close to clean up.
47 \par Nice thing the first:
48 * Any step in the stream can callback with data
49 * representing an error.
50 * Nice thing the second: once you stop requesting reads from upstream,
51 * upstream can be stopped too.
54 * Error has a callback mechanism to hand over a membuf
55 * with the error content. The failing node pushes that back as the
56 * reply. Can this be generalised to reduce duplicate efforts?
57 * A: Possibly. For now, only one location uses this.
58 * How to deal with pre-stream errors?
59 * Tell client_side_reply that we *want* an error page before any
60 * stream calls occur. Then we simply read as normal.
63 \section pconn_logic Persistent connection logic:
66 * requests (httpClientRequest structs) get added to the connection
67 * list, with the current one being chr
70 * The request is *immediately* kicked off, and data flows through
71 * to clientSocketRecipient.
74 * If the data that arrives at clientSocketRecipient is not for the current
75 * request, clientSocketRecipient simply returns, without requesting more
76 * data, or sending it.
79 * ClientKeepAliveNextRequest will then detect the presence of data in
80 * the next ClientHttpRequest, and will send it, restablishing the
84 #include "squid-old.h"
86 #include "acl/FilledChecklist.h"
88 #include "auth/UserRequest.h"
90 #include "base/Subscription.h"
91 #include "base/TextException.h"
92 #include "ChunkedCodingParser.h"
93 #include "client_side.h"
94 #include "client_side_reply.h"
95 #include "client_side_request.h"
97 #include "ClientInfo.h"
99 #include "ClientRequestContext.h"
100 #include "clientStream.h"
102 #include "comm/Connection.h"
103 #include "CommCalls.h"
104 #include "comm/Loops.h"
105 #include "comm/Write.h"
106 #include "comm/TcpAcceptor.h"
107 #include "eui/Config.h"
109 #include "HttpHdrContRange.h"
110 #include "HttpReply.h"
111 #include "HttpRequest.h"
112 #include "ident/Config.h"
113 #include "ident/Ident.h"
114 #include "ipc/FdNotes.h"
115 #include "ipc/StartListening.h"
117 #include "MemObject.h"
118 #include "ProtoPort.h"
120 #include "StatCounters.h"
121 #include "StatHist.h"
122 #include "SquidTime.h"
124 #include "ssl/context_storage.h"
125 #include "ssl/helper.h"
126 #include "ssl/support.h"
127 #include "ssl/gadgets.h"
130 #include "ssl/crtd_message.h"
131 #include "ssl/certificate_db.h"
134 #include "TimeOrTag.h"
141 #define comm_close comm_lingering_close
144 /// dials clientListenerConnectionOpened call
145 class ListeningStartedDialer
: public CallDialer
, public Ipc::StartListeningCb
148 typedef void (*Handler
)(http_port_list
*portCfg
, const Ipc::FdNoteId note
, const Subscription::Pointer
&sub
);
149 ListeningStartedDialer(Handler aHandler
, http_port_list
*aPortCfg
, const Ipc::FdNoteId note
, const Subscription::Pointer
&aSub
):
150 handler(aHandler
), portCfg(aPortCfg
), portTypeNote(note
), sub(aSub
) {}
152 virtual void print(std::ostream
&os
) const {
154 ", " << FdNote(portTypeNote
) << " port=" << (void*)portCfg
<< ')';
157 virtual bool canDial(AsyncCall
&) const { return true; }
158 virtual void dial(AsyncCall
&) { (handler
)(portCfg
, portTypeNote
, sub
); }
164 http_port_list
*portCfg
; ///< from Config.Sockaddr.http
165 Ipc::FdNoteId portTypeNote
; ///< Type of IPC socket being opened
166 Subscription::Pointer sub
; ///< The handler to be subscribed for this connetion listener
169 static void clientListenerConnectionOpened(http_port_list
*s
, const Ipc::FdNoteId portTypeNote
, const Subscription::Pointer
&sub
);
171 /* our socket-related context */
174 CBDATA_CLASS_INIT(ClientSocketContext
);
177 ClientSocketContext::operator new (size_t byteCount
)
179 /* derived classes with different sizes must implement their own new */
180 assert (byteCount
== sizeof (ClientSocketContext
));
181 CBDATA_INIT_TYPE(ClientSocketContext
);
182 return cbdataAlloc(ClientSocketContext
);
186 ClientSocketContext::operator delete (void *address
)
188 cbdataFree (address
);
191 /* Local functions */
192 /* ClientSocketContext */
193 static ClientSocketContext
*ClientSocketContextNew(const Comm::ConnectionPointer
&clientConn
, ClientHttpRequest
*);
195 static IOCB clientWriteComplete
;
196 static IOCB clientWriteBodyComplete
;
197 static IOACB httpAccept
;
199 static IOACB httpsAccept
;
201 static CTCB clientLifetimeTimeout
;
202 static ClientSocketContext
*parseHttpRequestAbort(ConnStateData
* conn
, const char *uri
);
203 static ClientSocketContext
*parseHttpRequest(ConnStateData
*, HttpParser
*, HttpRequestMethod
*, HttpVersion
*);
205 static IDCB clientIdentDone
;
207 static CSCB clientSocketRecipient
;
208 static CSD clientSocketDetach
;
209 static void clientSetKeepaliveFlag(ClientHttpRequest
*);
210 static int clientIsContentLengthValid(HttpRequest
* r
);
211 static int clientIsRequestBodyTooLargeForPolicy(int64_t bodyLength
);
213 static void clientUpdateStatHistCounters(log_type logType
, int svc_time
);
214 static void clientUpdateStatCounters(log_type logType
);
215 static void clientUpdateHierCounters(HierarchyLogEntry
*);
216 static bool clientPingHasFinished(ping_data
const *aPing
);
217 void prepareLogWithRequestDetails(HttpRequest
*, AccessLogEntry
*);
219 static bool connIsUsable(ConnStateData
* conn
);
221 static int responseFinishedOrFailed(HttpReply
* rep
, StoreIOBuffer
const &receivedData
);
222 static void ClientSocketContextPushDeferredIfNeeded(ClientSocketContext::Pointer deferredRequest
, ConnStateData
* conn
);
223 static void clientUpdateSocketStats(log_type logType
, size_t size
);
225 char *skipLeadingSpace(char *aString
);
226 static void connNoteUseOfBuffer(ConnStateData
* conn
, size_t byteCount
);
228 static ConnStateData
*connStateCreate(const Comm::ConnectionPointer
&client
, http_port_list
*port
);
232 ClientSocketContext::getTail() const
234 if (http
->client_stream
.tail
)
235 return (clientStreamNode
*)http
->client_stream
.tail
->data
;
241 ClientSocketContext::getClientReplyContext() const
243 return (clientStreamNode
*)http
->client_stream
.tail
->prev
->data
;
247 * This routine should be called to grow the inbuf and then
251 ConnStateData::readSomeData()
256 debugs(33, 4, HERE
<< clientConnection
<< ": reading request...");
258 if (!maybeMakeSpaceAvailable())
261 typedef CommCbMemFunT
<ConnStateData
, CommIoCbParams
> Dialer
;
262 reader
= JobCallback(33, 5, Dialer
, this, ConnStateData::clientReadRequest
);
263 comm_read(clientConnection
, in
.addressToReadInto(), getAvailableBufferLength(), reader
);
268 ClientSocketContext::removeFromConnectionList(ConnStateData
* conn
)
270 ClientSocketContext::Pointer
*tempContextPointer
;
271 assert(conn
!= NULL
&& cbdataReferenceValid(conn
));
272 assert(conn
->getCurrentContext() != NULL
);
273 /* Unlink us from the connection request list */
274 tempContextPointer
= & conn
->currentobject
;
276 while (tempContextPointer
->getRaw()) {
277 if (*tempContextPointer
== this)
280 tempContextPointer
= &(*tempContextPointer
)->next
;
283 assert(tempContextPointer
->getRaw() != NULL
);
284 *tempContextPointer
= next
;
288 ClientSocketContext::~ClientSocketContext()
290 clientStreamNode
*node
= getTail();
293 ClientSocketContext
*streamContext
= dynamic_cast<ClientSocketContext
*> (node
->data
.getRaw());
296 /* We are *always* the tail - prevent recursive free */
297 assert(this == streamContext
);
303 deRegisterWithConn();
305 httpRequestFree(http
);
307 /* clean up connection links to us */
308 assert(this != next
.getRaw());
312 ClientSocketContext::registerWithConn()
314 assert (!connRegistered_
);
316 assert (http
->getConn() != NULL
);
317 connRegistered_
= true;
318 http
->getConn()->addContextToQueue(this);
322 ClientSocketContext::deRegisterWithConn()
324 assert (connRegistered_
);
325 removeFromConnectionList(http
->getConn());
326 connRegistered_
= false;
330 ClientSocketContext::connIsFinished()
333 assert (http
->getConn() != NULL
);
334 deRegisterWithConn();
335 /* we can't handle any more stream data - detach */
336 clientStreamDetach(getTail(), http
);
339 ClientSocketContext::ClientSocketContext() : http(NULL
), reply(NULL
), next(NULL
),
341 mayUseConnection_ (false),
342 connRegistered_ (false)
344 memset (reqbuf
, '\0', sizeof (reqbuf
));
347 deferredparams
.node
= NULL
;
348 deferredparams
.rep
= NULL
;
351 ClientSocketContext
*
352 ClientSocketContextNew(const Comm::ConnectionPointer
&client
, ClientHttpRequest
* http
)
354 ClientSocketContext
*newContext
;
355 assert(http
!= NULL
);
356 newContext
= new ClientSocketContext
;
357 newContext
->http
= http
;
358 newContext
->clientConnection
= client
;
363 ClientSocketContext::writeControlMsg(HttpControlMsg
&msg
)
365 HttpReply
*rep
= msg
.reply
;
368 // apply selected clientReplyContext::buildReplyHeader() mods
369 // it is not clear what headers are required for control messages
370 rep
->header
.removeHopByHopEntries();
371 rep
->header
.putStr(HDR_CONNECTION
, "keep-alive");
372 httpHdrMangleList(&rep
->header
, http
->request
, ROR_REPLY
);
374 // remember the callback
375 cbControlMsgSent
= msg
.cbSuccess
;
377 MemBuf
*mb
= rep
->pack();
379 debugs(11, 2, "HTTP Client " << clientConnection
);
380 debugs(11, 2, "HTTP Client CONTROL MSG:\n---------\n" << mb
->buf
<< "\n----------");
382 AsyncCall::Pointer call
= commCbCall(33, 5, "ClientSocketContext::wroteControlMsg",
383 CommIoCbPtrFun(&WroteControlMsg
, this));
384 Comm::Write(clientConnection
, mb
, call
);
389 /// called when we wrote the 1xx response
391 ClientSocketContext::wroteControlMsg(const Comm::ConnectionPointer
&conn
, char *, size_t, comm_err_t errflag
, int xerrno
)
393 if (errflag
== COMM_ERR_CLOSING
)
396 if (errflag
== COMM_OK
) {
397 ScheduleCallHere(cbControlMsgSent
);
401 debugs(33, 3, HERE
<< "1xx writing failed: " << xstrerr(xerrno
));
402 // no error notification: see HttpControlMsg.h for rationale and
403 // note that some errors are detected elsewhere (e.g., close handler)
405 // close on 1xx errors to be conservative and to simplify the code
406 // (if we do not close, we must notify the source of a failure!)
410 /// wroteControlMsg() wrapper: ClientSocketContext is not an AsyncJob
412 ClientSocketContext::WroteControlMsg(const Comm::ConnectionPointer
&conn
, char *bufnotused
, size_t size
, comm_err_t errflag
, int xerrno
, void *data
)
414 ClientSocketContext
*context
= static_cast<ClientSocketContext
*>(data
);
415 context
->wroteControlMsg(conn
, bufnotused
, size
, errflag
, xerrno
);
420 clientIdentDone(const char *ident
, void *data
)
422 ConnStateData
*conn
= (ConnStateData
*)data
;
423 xstrncpy(conn
->clientConnection
->rfc931
, ident
? ident
: dash_str
, USER_IDENT_SZ
);
428 clientUpdateStatCounters(log_type logType
)
430 ++statCounter
.client_http
.requests
;
432 if (logTypeIsATcpHit(logType
))
433 ++statCounter
.client_http
.hits
;
435 if (logType
== LOG_TCP_HIT
)
436 ++statCounter
.client_http
.disk_hits
;
437 else if (logType
== LOG_TCP_MEM_HIT
)
438 ++statCounter
.client_http
.mem_hits
;
442 clientUpdateStatHistCounters(log_type logType
, int svc_time
)
444 statCounter
.client_http
.allSvcTime
.count(svc_time
);
446 * The idea here is not to be complete, but to get service times
447 * for only well-defined types. For example, we don't include
448 * LOG_TCP_REFRESH_FAIL because its not really a cache hit
449 * (we *tried* to validate it, but failed).
454 case LOG_TCP_REFRESH_UNMODIFIED
:
455 statCounter
.client_http
.nearHitSvcTime
.count(svc_time
);
458 case LOG_TCP_IMS_HIT
:
459 statCounter
.client_http
.nearMissSvcTime
.count(svc_time
);
464 case LOG_TCP_MEM_HIT
:
466 case LOG_TCP_OFFLINE_HIT
:
467 statCounter
.client_http
.hitSvcTime
.count(svc_time
);
472 case LOG_TCP_CLIENT_REFRESH_MISS
:
473 statCounter
.client_http
.missSvcTime
.count(svc_time
);
477 /* make compiler warnings go away */
483 clientPingHasFinished(ping_data
const *aPing
)
485 if (0 != aPing
->stop
.tv_sec
&& 0 != aPing
->start
.tv_sec
)
492 clientUpdateHierCounters(HierarchyLogEntry
* someEntry
)
496 switch (someEntry
->code
) {
497 #if USE_CACHE_DIGESTS
502 statCounter
.cd
.times_used
++;
510 case FIRST_PARENT_MISS
:
512 case CLOSEST_PARENT_MISS
:
513 statCounter
.icp
.times_used
++;
514 i
= &someEntry
->ping
;
516 if (clientPingHasFinished(i
))
517 statCounter
.icp
.querySvcTime
.count(tvSubUsec(i
->start
, i
->stop
));
520 statCounter
.icp
.query_timeouts
++;
527 statCounter
.netdb
.times_used
++;
537 ClientHttpRequest::updateCounters()
539 clientUpdateStatCounters(logType
);
541 if (request
->errType
!= ERR_NONE
)
542 statCounter
.client_http
.errors
++;
544 clientUpdateStatHistCounters(logType
,
545 tvSubMsec(start_time
, current_time
));
547 clientUpdateHierCounters(&request
->hier
);
551 prepareLogWithRequestDetails(HttpRequest
* request
, AccessLogEntry
* aLogEntry
)
556 if (Config
.onoff
.log_mime_hdrs
) {
560 packerToMemInit(&p
, &mb
);
561 request
->header
.packInto(&p
);
562 //This is the request after adaptation or redirection
563 aLogEntry
->headers
.adapted_request
= xstrdup(mb
.buf
);
565 // the virgin request is saved to aLogEntry->request
566 if (aLogEntry
->request
) {
569 packerToMemInit(&p
, &mb
);
570 aLogEntry
->request
->header
.packInto(&p
);
571 aLogEntry
->headers
.request
= xstrdup(mb
.buf
);
575 const Adaptation::History::Pointer ah
= request
->adaptLogHistory();
579 packerToMemInit(&p
, &mb
);
580 ah
->lastMeta
.packInto(&p
);
581 aLogEntry
->adapt
.last_meta
= xstrdup(mb
.buf
);
590 const Adaptation::Icap::History::Pointer ih
= request
->icapHistory();
592 aLogEntry
->icap
.processingTime
= ih
->processingTime();
595 aLogEntry
->http
.method
= request
->method
;
596 aLogEntry
->http
.version
= request
->http_ver
;
597 aLogEntry
->hier
= request
->hier
;
598 if (request
->content_length
> 0) // negative when no body or unknown length
599 aLogEntry
->cache
.requestSize
+= request
->content_length
;
600 aLogEntry
->cache
.extuser
= request
->extacl_user
.termedBuf();
603 if (request
->auth_user_request
!= NULL
) {
604 if (request
->auth_user_request
->username())
605 aLogEntry
->cache
.authuser
= xstrdup(request
->auth_user_request
->username());
609 // Adapted request, if any, inherits and then collects all the stats, but
610 // the virgin request gets logged instead; copy the stats to log them.
611 // TODO: avoid losses by keeping these stats in a shared history object?
612 if (aLogEntry
->request
) {
613 aLogEntry
->request
->dnsWait
= request
->dnsWait
;
614 aLogEntry
->request
->errType
= request
->errType
;
615 aLogEntry
->request
->errDetail
= request
->errDetail
;
620 ClientHttpRequest::logRequest()
622 if (!out
.size
&& !logType
)
623 debugs(33, 5, HERE
<< "logging half-baked transaction: " << log_uri
);
625 al
.icp
.opcode
= ICP_INVALID
;
627 debugs(33, 9, "clientLogRequest: al.url='" << al
.url
<< "'");
630 al
.http
.code
= al
.reply
->sline
.status
;
631 al
.http
.content_type
= al
.reply
->content_type
.termedBuf();
632 } else if (loggingEntry() && loggingEntry()->mem_obj
) {
633 al
.http
.code
= loggingEntry()->mem_obj
->getReply()->sline
.status
;
634 al
.http
.content_type
= loggingEntry()->mem_obj
->getReply()->content_type
.termedBuf();
637 debugs(33, 9, "clientLogRequest: http.code='" << al
.http
.code
<< "'");
639 if (loggingEntry() && loggingEntry()->mem_obj
)
640 al
.cache
.objectSize
= loggingEntry()->contentLen();
642 al
.cache
.caddr
.SetNoAddr();
644 if (getConn() != NULL
) {
645 al
.cache
.caddr
= getConn()->log_addr
;
646 al
.cache
.port
= cbdataReference(getConn()->port
);
649 al
.cache
.requestSize
= req_sz
;
650 al
.cache
.requestHeadersSize
= req_sz
;
652 al
.cache
.replySize
= out
.size
;
653 al
.cache
.replyHeadersSize
= out
.headers_sz
;
655 al
.cache
.highOffset
= out
.offset
;
657 al
.cache
.code
= logType
;
659 al
.cache
.msec
= tvSubMsec(start_time
, current_time
);
662 prepareLogWithRequestDetails(request
, &al
);
664 if (getConn() != NULL
&& getConn()->clientConnection
!= NULL
&& getConn()->clientConnection
->rfc931
[0])
665 al
.cache
.rfc931
= getConn()->clientConnection
->rfc931
;
669 /* This is broken. Fails if the connection has been closed. Needs
670 * to snarf the ssl details some place earlier..
672 if (getConn() != NULL
)
673 al
.cache
.ssluser
= sslGetUserEmail(fd_table
[getConn()->fd
].ssl
);
677 ACLFilledChecklist
*checklist
= clientAclChecklistCreate(Config
.accessList
.log
, this);
680 checklist
->reply
= HTTPMSGLOCK(al
.reply
);
682 if (!Config
.accessList
.log
|| checklist
->fastCheck() == ACCESS_ALLOWED
) {
684 al
.adapted_request
= HTTPMSGLOCK(request
);
685 accessLogLog(&al
, checklist
);
688 if (getConn() != NULL
&& getConn()->clientConnection
!= NULL
)
689 clientdbUpdate(getConn()->clientConnection
->remote
, logType
, AnyP::PROTO_HTTP
, out
.size
);
694 accessLogFreeMemory(&al
);
698 ClientHttpRequest::freeResources()
702 safe_free(redirect
.location
);
703 range_iter
.boundary
.clean();
704 HTTPMSGUNLOCK(request
);
706 if (client_stream
.tail
)
707 clientStreamAbort((clientStreamNode
*)client_stream
.tail
->data
, this);
711 httpRequestFree(void *data
)
713 ClientHttpRequest
*http
= (ClientHttpRequest
*)data
;
714 assert(http
!= NULL
);
719 ConnStateData::areAllContextsForThisConnection() const
721 assert(this != NULL
);
722 ClientSocketContext::Pointer context
= getCurrentContext();
724 while (context
.getRaw()) {
725 if (context
->http
->getConn() != this)
728 context
= context
->next
;
735 ConnStateData::freeAllContexts()
737 ClientSocketContext::Pointer context
;
739 while ((context
= getCurrentContext()).getRaw() != NULL
) {
740 assert(getCurrentContext() !=
741 getCurrentContext()->next
);
742 context
->connIsFinished();
743 assert (context
!= currentobject
);
747 /// propagates abort event to all contexts
749 ConnStateData::notifyAllContexts(int xerrno
)
751 typedef ClientSocketContext::Pointer CSCP
;
752 for (CSCP c
= getCurrentContext(); c
.getRaw(); c
= c
->next
)
753 c
->noteIoError(xerrno
);
756 /* This is a handler normally called by comm_close() */
757 void ConnStateData::connStateClosed(const CommCloseCbParams
&io
)
759 deleteThis("ConnStateData::connStateClosed");
762 // cleans up before destructor is called
764 ConnStateData::swanSong()
766 debugs(33, 2, HERE
<< clientConnection
);
767 flags
.readMore
= false;
768 clientdbEstablished(clientConnection
->remote
, -1); /* decrement */
769 assert(areAllContextsForThisConnection());
772 if (auth_user_request
!= NULL
) {
773 debugs(33, 4, "ConnStateData::swanSong: freeing auth_user_request '" << auth_user_request
<< "' (this is '" << this << "')");
774 auth_user_request
->onConnectionClose(this);
778 if (Comm::IsConnOpen(pinning
.serverConnection
))
779 pinning
.serverConnection
->close();
780 pinning
.serverConnection
= NULL
;
782 if (Comm::IsConnOpen(clientConnection
))
783 clientConnection
->close();
784 clientConnection
= NULL
;
786 BodyProducer::swanSong();
787 flags
.swanSang
= true;
791 ConnStateData::isOpen() const
793 return cbdataReferenceValid(this) && // XXX: checking "this" in a method
794 Comm::IsConnOpen(clientConnection
) &&
795 !fd_table
[clientConnection
->fd
].closing();
798 ConnStateData::~ConnStateData()
800 assert(this != NULL
);
801 debugs(33, 3, HERE
<< clientConnection
);
804 debugs(33, 1, "BUG: ConnStateData did not close " << clientConnection
);
807 debugs(33, 1, "BUG: ConnStateData was not destroyed properly; " << clientConnection
);
809 cbdataReferenceDone(port
);
811 if (bodyPipe
!= NULL
)
812 stopProducingFor(bodyPipe
, false);
816 * clientSetKeepaliveFlag() sets request->flags.proxy_keepalive.
817 * This is the client-side persistent connection flag. We need
818 * to set this relatively early in the request processing
819 * to handle hacks for broken servers and clients.
822 clientSetKeepaliveFlag(ClientHttpRequest
* http
)
824 HttpRequest
*request
= http
->request
;
826 debugs(33, 3, "clientSetKeepaliveFlag: http_ver = " <<
827 request
->http_ver
.major
<< "." << request
->http_ver
.minor
);
828 debugs(33, 3, "clientSetKeepaliveFlag: method = " <<
829 RequestMethodStr(request
->method
));
831 // TODO: move to HttpRequest::hdrCacheInit, just like HttpReply.
832 request
->flags
.proxy_keepalive
= request
->persistent() ? 1 : 0;
836 clientIsContentLengthValid(HttpRequest
* r
)
838 switch (r
->method
.id()) {
843 /* We do not want to see a request entity on GET/HEAD requests */
844 return (r
->content_length
<= 0 || Config
.onoff
.request_entities
);
847 /* For other types of requests we don't care */
855 clientIsRequestBodyTooLargeForPolicy(int64_t bodyLength
)
857 if (Config
.maxRequestBodySize
&&
858 bodyLength
> Config
.maxRequestBodySize
)
859 return 1; /* too large */
866 connIsUsable(ConnStateData
* conn
)
868 if (conn
== NULL
|| !cbdataReferenceValid(conn
) || !Comm::IsConnOpen(conn
->clientConnection
))
876 // careful: the "current" context may be gone if we wrote an early response
877 ClientSocketContext::Pointer
878 ConnStateData::getCurrentContext() const
881 return currentobject
;
885 ClientSocketContext::deferRecipientForLater(clientStreamNode
* node
, HttpReply
* rep
, StoreIOBuffer receivedData
)
887 debugs(33, 2, "clientSocketRecipient: Deferring request " << http
->uri
);
888 assert(flags
.deferred
== 0);
890 deferredparams
.node
= node
;
891 deferredparams
.rep
= rep
;
892 deferredparams
.queuedBuffer
= receivedData
;
897 responseFinishedOrFailed(HttpReply
* rep
, StoreIOBuffer
const & receivedData
)
899 if (rep
== NULL
&& receivedData
.data
== NULL
&& receivedData
.length
== 0)
906 ClientSocketContext::startOfOutput() const
908 return http
->out
.size
== 0;
912 ClientSocketContext::lengthToSend(Range
<int64_t> const &available
)
914 /*the size of available range can always fit in a size_t type*/
915 size_t maximum
= (size_t)available
.size();
917 if (!http
->request
->range
)
920 assert (canPackMoreRanges());
922 if (http
->range_iter
.debt() == -1)
925 assert (http
->range_iter
.debt() > 0);
927 /* TODO this + the last line could be a range intersection calculation */
928 if (available
.start
< http
->range_iter
.currentSpec()->offset
)
931 return min(http
->range_iter
.debt(), (int64_t)maximum
);
935 ClientSocketContext::noteSentBodyBytes(size_t bytes
)
937 http
->out
.offset
+= bytes
;
939 if (!http
->request
->range
)
942 if (http
->range_iter
.debt() != -1) {
943 http
->range_iter
.debt(http
->range_iter
.debt() - bytes
);
944 assert (http
->range_iter
.debt() >= 0);
947 /* debt() always stops at -1, below that is a bug */
948 assert (http
->range_iter
.debt() >= -1);
952 ClientHttpRequest::multipartRangeRequest() const
954 return request
->multipartRangeRequest();
958 ClientSocketContext::multipartRangeRequest() const
960 return http
->multipartRangeRequest();
964 ClientSocketContext::sendBody(HttpReply
* rep
, StoreIOBuffer bodyData
)
968 if (!multipartRangeRequest() && !http
->request
->flags
.chunked_reply
) {
969 size_t length
= lengthToSend(bodyData
.range());
970 noteSentBodyBytes (length
);
971 AsyncCall::Pointer call
= commCbCall(33, 5, "clientWriteBodyComplete",
972 CommIoCbPtrFun(clientWriteBodyComplete
, this));
973 Comm::Write(clientConnection
, bodyData
.data
, length
, call
, NULL
);
979 if (multipartRangeRequest())
980 packRange(bodyData
, &mb
);
982 packChunk(bodyData
, mb
);
984 if (mb
.contentSize()) {
986 AsyncCall::Pointer call
= commCbCall(33, 5, "clientWriteComplete",
987 CommIoCbPtrFun(clientWriteComplete
, this));
988 Comm::Write(clientConnection
, &mb
, call
);
990 writeComplete(clientConnection
, NULL
, 0, COMM_OK
);
994 * Packs bodyData into mb using chunked encoding. Packs the last-chunk
995 * if bodyData is empty.
998 ClientSocketContext::packChunk(const StoreIOBuffer
&bodyData
, MemBuf
&mb
)
1000 const uint64_t length
=
1001 static_cast<uint64_t>(lengthToSend(bodyData
.range()));
1002 noteSentBodyBytes(length
);
1004 mb
.Printf("%"PRIX64
"\r\n", length
);
1005 mb
.append(bodyData
.data
, length
);
1009 /** put terminating boundary for multiparts */
1011 clientPackTermBound(String boundary
, MemBuf
* mb
)
1013 mb
->Printf("\r\n--" SQUIDSTRINGPH
"--\r\n", SQUIDSTRINGPRINT(boundary
));
1014 debugs(33, 6, "clientPackTermBound: buf offset: " << mb
->size
);
1017 /** appends a "part" HTTP header (as in a multi-part/range reply) to the buffer */
1019 clientPackRangeHdr(const HttpReply
* rep
, const HttpHdrRangeSpec
* spec
, String boundary
, MemBuf
* mb
)
1021 HttpHeader
hdr(hoReply
);
1027 debugs(33, 5, "clientPackRangeHdr: appending boundary: " << boundary
);
1028 /* rfc2046 requires to _prepend_ boundary with <crlf>! */
1029 mb
->Printf("\r\n--" SQUIDSTRINGPH
"\r\n", SQUIDSTRINGPRINT(boundary
));
1031 /* stuff the header with required entries and pack it */
1033 if (rep
->header
.has(HDR_CONTENT_TYPE
))
1034 hdr
.putStr(HDR_CONTENT_TYPE
, rep
->header
.getStr(HDR_CONTENT_TYPE
));
1036 httpHeaderAddContRange(&hdr
, *spec
, rep
->content_length
);
1038 packerToMemInit(&p
, mb
);
1046 /* append <crlf> (we packed a header, not a reply) */
1051 * extracts a "range" from *buf and appends them to mb, updating
1052 * all offsets and such.
1055 ClientSocketContext::packRange(StoreIOBuffer
const &source
, MemBuf
* mb
)
1057 HttpHdrRangeIter
* i
= &http
->range_iter
;
1058 Range
<int64_t> available (source
.range());
1059 char const *buf
= source
.data
;
1061 while (i
->currentSpec() && available
.size()) {
1062 const size_t copy_sz
= lengthToSend(available
);
1066 * intersection of "have" and "need" ranges must not be empty
1068 assert(http
->out
.offset
< i
->currentSpec()->offset
+ i
->currentSpec()->length
);
1069 assert(http
->out
.offset
+ (int64_t)available
.size() > i
->currentSpec()->offset
);
1072 * put boundary and headers at the beginning of a range in a
1076 if (http
->multipartRangeRequest() && i
->debt() == i
->currentSpec()->length
) {
1077 assert(http
->memObject());
1079 http
->memObject()->getReply(), /* original reply */
1080 i
->currentSpec(), /* current range */
1081 i
->boundary
, /* boundary, the same for all */
1088 debugs(33, 3, "clientPackRange: appending " << copy_sz
<< " bytes");
1090 noteSentBodyBytes (copy_sz
);
1092 mb
->append(buf
, copy_sz
);
1097 available
.start
+= copy_sz
;
1103 if (!canPackMoreRanges()) {
1104 debugs(33, 3, "clientPackRange: Returning because !canPackMoreRanges.");
1107 /* put terminating boundary for multiparts */
1108 clientPackTermBound(i
->boundary
, mb
);
1113 int64_t nextOffset
= getNextRangeOffset();
1115 assert (nextOffset
>= http
->out
.offset
);
1117 int64_t skip
= nextOffset
- http
->out
.offset
;
1119 /* adjust for not to be transmitted bytes */
1120 http
->out
.offset
= nextOffset
;
1122 if (available
.size() <= (uint64_t)skip
)
1125 available
.start
+= skip
;
1134 /** returns expected content length for multi-range replies
1135 * note: assumes that httpHdrRangeCanonize has already been called
1136 * warning: assumes that HTTP headers for individual ranges at the
1137 * time of the actuall assembly will be exactly the same as
1138 * the headers when clientMRangeCLen() is called */
1140 ClientHttpRequest::mRangeCLen()
1145 assert(memObject());
1148 HttpHdrRange::iterator pos
= request
->range
->begin();
1150 while (pos
!= request
->range
->end()) {
1151 /* account for headers for this range */
1153 clientPackRangeHdr(memObject()->getReply(),
1154 *pos
, range_iter
.boundary
, &mb
);
1157 /* account for range content */
1158 clen
+= (*pos
)->length
;
1160 debugs(33, 6, "clientMRangeCLen: (clen += " << mb
.size
<< " + " << (*pos
)->length
<< ") == " << clen
);
1164 /* account for the terminating boundary */
1167 clientPackTermBound(range_iter
.boundary
, &mb
);
1177 * returns true if If-Range specs match reply, false otherwise
1180 clientIfRangeMatch(ClientHttpRequest
* http
, HttpReply
* rep
)
1182 const TimeOrTag spec
= http
->request
->header
.getTimeOrTag(HDR_IF_RANGE
);
1183 /* check for parsing falure */
1190 ETag rep_tag
= rep
->header
.getETag(HDR_ETAG
);
1191 debugs(33, 3, "clientIfRangeMatch: ETags: " << spec
.tag
.str
<< " and " <<
1192 (rep_tag
.str
? rep_tag
.str
: "<none>"));
1195 return 0; /* entity has no etag to compare with! */
1197 if (spec
.tag
.weak
|| rep_tag
.weak
) {
1198 debugs(33, 1, "clientIfRangeMatch: Weak ETags are not allowed in If-Range: " << spec
.tag
.str
<< " ? " << rep_tag
.str
);
1199 return 0; /* must use strong validator for sub-range requests */
1202 return etagIsStrongEqual(rep_tag
, spec
.tag
);
1205 /* got modification time? */
1206 if (spec
.time
>= 0) {
1207 return http
->storeEntry()->lastmod
<= spec
.time
;
1210 assert(0); /* should not happen */
1215 * generates a "unique" boundary string for multipart responses
1216 * the caller is responsible for cleaning the string */
1218 ClientHttpRequest::rangeBoundaryStr() const
1222 String
b(APP_FULLNAME
);
1224 key
= storeEntry()->getMD5Text();
1225 b
.append(key
, strlen(key
));
1229 /** adds appropriate Range headers if needed */
1231 ClientSocketContext::buildRangeHeader(HttpReply
* rep
)
1233 HttpHeader
*hdr
= rep
? &rep
->header
: 0;
1234 const char *range_err
= NULL
;
1235 HttpRequest
*request
= http
->request
;
1236 assert(request
->range
);
1237 /* check if we still want to do ranges */
1239 int64_t roffLimit
= request
->getRangeOffsetLimit();
1242 range_err
= "no [parse-able] reply";
1243 else if ((rep
->sline
.status
!= HTTP_OK
) && (rep
->sline
.status
!= HTTP_PARTIAL_CONTENT
))
1244 range_err
= "wrong status code";
1245 else if (hdr
->has(HDR_CONTENT_RANGE
))
1246 range_err
= "origin server does ranges";
1247 else if (rep
->content_length
< 0)
1248 range_err
= "unknown length";
1249 else if (rep
->content_length
!= http
->memObject()->getReply()->content_length
)
1250 range_err
= "INCONSISTENT length"; /* a bug? */
1252 /* hits only - upstream peer determines correct behaviour on misses, and client_side_reply determines
1255 else if (logTypeIsATcpHit(http
->logType
) && http
->request
->header
.has(HDR_IF_RANGE
) && !clientIfRangeMatch(http
, rep
))
1256 range_err
= "If-Range match failed";
1257 else if (!http
->request
->range
->canonize(rep
))
1258 range_err
= "canonization failed";
1259 else if (http
->request
->range
->isComplex())
1260 range_err
= "too complex range header";
1261 else if (!logTypeIsATcpHit(http
->logType
) && http
->request
->range
->offsetLimitExceeded(roffLimit
))
1262 range_err
= "range outside range_offset_limit";
1264 /* get rid of our range specs on error */
1266 /* XXX We do this here because we need canonisation etc. However, this current
1267 * code will lead to incorrect store offset requests - the store will have the
1268 * offset data, but we won't be requesting it.
1269 * So, we can either re-request, or generate an error
1271 debugs(33, 3, "clientBuildRangeHeader: will not do ranges: " << range_err
<< ".");
1272 delete http
->request
->range
;
1273 http
->request
->range
= NULL
;
1275 /* XXX: TODO: Review, this unconditional set may be wrong. - TODO: review. */
1276 httpStatusLineSet(&rep
->sline
, rep
->sline
.version
,
1277 HTTP_PARTIAL_CONTENT
, NULL
);
1278 // web server responded with a valid, but unexpected range.
1279 // will (try-to) forward as-is.
1280 //TODO: we should cope with multirange request/responses
1281 bool replyMatchRequest
= rep
->content_range
!= NULL
?
1282 request
->range
->contains(rep
->content_range
->spec
) :
1284 const int spec_count
= http
->request
->range
->specs
.count
;
1285 int64_t actual_clen
= -1;
1287 debugs(33, 3, "clientBuildRangeHeader: range spec count: " <<
1288 spec_count
<< " virgin clen: " << rep
->content_length
);
1289 assert(spec_count
> 0);
1290 /* append appropriate header(s) */
1292 if (spec_count
== 1) {
1293 if (!replyMatchRequest
) {
1294 hdr
->delById(HDR_CONTENT_RANGE
);
1295 hdr
->putContRange(rep
->content_range
);
1296 actual_clen
= rep
->content_length
;
1297 //http->range_iter.pos = rep->content_range->spec.begin();
1298 (*http
->range_iter
.pos
)->offset
= rep
->content_range
->spec
.offset
;
1299 (*http
->range_iter
.pos
)->length
= rep
->content_range
->spec
.length
;
1302 HttpHdrRange::iterator pos
= http
->request
->range
->begin();
1304 /* append Content-Range */
1306 if (!hdr
->has(HDR_CONTENT_RANGE
)) {
1307 /* No content range, so this was a full object we are
1310 httpHeaderAddContRange(hdr
, **pos
, rep
->content_length
);
1313 /* set new Content-Length to the actual number of bytes
1314 * transmitted in the message-body */
1315 actual_clen
= (*pos
)->length
;
1319 /* generate boundary string */
1320 http
->range_iter
.boundary
= http
->rangeBoundaryStr();
1321 /* delete old Content-Type, add ours */
1322 hdr
->delById(HDR_CONTENT_TYPE
);
1323 httpHeaderPutStrf(hdr
, HDR_CONTENT_TYPE
,
1324 "multipart/byteranges; boundary=\"" SQUIDSTRINGPH
"\"",
1325 SQUIDSTRINGPRINT(http
->range_iter
.boundary
));
1326 /* Content-Length is not required in multipart responses
1327 * but it is always nice to have one */
1328 actual_clen
= http
->mRangeCLen();
1329 /* http->out needs to start where we want data at */
1330 http
->out
.offset
= http
->range_iter
.currentSpec()->offset
;
1333 /* replace Content-Length header */
1334 assert(actual_clen
>= 0);
1336 hdr
->delById(HDR_CONTENT_LENGTH
);
1338 hdr
->putInt64(HDR_CONTENT_LENGTH
, actual_clen
);
1340 debugs(33, 3, "clientBuildRangeHeader: actual content length: " << actual_clen
);
1342 /* And start the range iter off */
1343 http
->range_iter
.updateSpec();
1348 ClientSocketContext::prepareReply(HttpReply
* rep
)
1352 if (http
->request
->range
)
1353 buildRangeHeader(rep
);
1357 ClientSocketContext::sendStartOfMessage(HttpReply
* rep
, StoreIOBuffer bodyData
)
1361 MemBuf
*mb
= rep
->pack();
1363 // dump now, so we dont output any body.
1364 debugs(11, 2, "HTTP Client " << clientConnection
);
1365 debugs(11, 2, "HTTP Client REPLY:\n---------\n" << mb
->buf
<< "\n----------");
1367 /* Save length of headers for persistent conn checks */
1368 http
->out
.headers_sz
= mb
->contentSize();
1371 headersLog(0, 0, http
->request
->method
, rep
);
1374 if (bodyData
.data
&& bodyData
.length
) {
1375 if (multipartRangeRequest())
1376 packRange(bodyData
, mb
);
1377 else if (http
->request
->flags
.chunked_reply
) {
1378 packChunk(bodyData
, *mb
);
1380 size_t length
= lengthToSend(bodyData
.range());
1381 noteSentBodyBytes (length
);
1383 mb
->append(bodyData
.data
, length
);
1388 debugs(33,7, HERE
<< "sendStartOfMessage schedules clientWriteComplete");
1389 AsyncCall::Pointer call
= commCbCall(33, 5, "clientWriteComplete",
1390 CommIoCbPtrFun(clientWriteComplete
, this));
1391 Comm::Write(clientConnection
, mb
, call
);
1396 * Write a chunk of data to a client socket. If the reply is present,
1397 * send the reply headers down the wire too, and clean them up when
1400 * The request is one backed by a connection, not an internal request.
1401 * data context is not NULL
1402 * There are no more entries in the stream chain.
1405 clientSocketRecipient(clientStreamNode
* node
, ClientHttpRequest
* http
,
1406 HttpReply
* rep
, StoreIOBuffer receivedData
)
1408 /* Test preconditions */
1409 assert(node
!= NULL
);
1410 PROF_start(clientSocketRecipient
);
1411 /* TODO: handle this rather than asserting
1412 * - it should only ever happen if we cause an abort and
1413 * the callback chain loops back to here, so we can simply return.
1414 * However, that itself shouldn't happen, so it stays as an assert for now.
1416 assert(cbdataReferenceValid(node
));
1417 assert(node
->node
.next
== NULL
);
1418 ClientSocketContext::Pointer context
= dynamic_cast<ClientSocketContext
*>(node
->data
.getRaw());
1419 assert(context
!= NULL
);
1420 assert(connIsUsable(http
->getConn()));
1422 /* TODO: check offset is what we asked for */
1424 if (context
!= http
->getConn()->getCurrentContext()) {
1425 context
->deferRecipientForLater(node
, rep
, receivedData
);
1426 PROF_stop(clientSocketRecipient
);
1430 // After sending Transfer-Encoding: chunked (at least), always send
1431 // the last-chunk if there was no error, ignoring responseFinishedOrFailed.
1432 const bool mustSendLastChunk
= http
->request
->flags
.chunked_reply
&&
1433 !http
->request
->flags
.stream_error
&& !context
->startOfOutput();
1434 if (responseFinishedOrFailed(rep
, receivedData
) && !mustSendLastChunk
) {
1435 context
->writeComplete(context
->clientConnection
, NULL
, 0, COMM_OK
);
1436 PROF_stop(clientSocketRecipient
);
1440 if (!context
->startOfOutput())
1441 context
->sendBody(rep
, receivedData
);
1444 http
->al
.reply
= HTTPMSGLOCK(rep
);
1445 context
->sendStartOfMessage(rep
, receivedData
);
1448 PROF_stop(clientSocketRecipient
);
1452 * Called when a downstream node is no longer interested in
1453 * our data. As we are a terminal node, this means on aborts
1457 clientSocketDetach(clientStreamNode
* node
, ClientHttpRequest
* http
)
1459 /* Test preconditions */
1460 assert(node
!= NULL
);
1461 /* TODO: handle this rather than asserting
1462 * - it should only ever happen if we cause an abort and
1463 * the callback chain loops back to here, so we can simply return.
1464 * However, that itself shouldn't happen, so it stays as an assert for now.
1466 assert(cbdataReferenceValid(node
));
1467 /* Set null by ContextFree */
1468 assert(node
->node
.next
== NULL
);
1469 /* this is the assert discussed above */
1470 assert(NULL
== dynamic_cast<ClientSocketContext
*>(node
->data
.getRaw()));
1471 /* We are only called when the client socket shutsdown.
1472 * Tell the prev pipeline member we're finished
1474 clientStreamDetach(node
, http
);
1478 clientWriteBodyComplete(const Comm::ConnectionPointer
&conn
, char *buf
, size_t size
, comm_err_t errflag
, int xerrno
, void *data
)
1480 debugs(33,7, HERE
<< "clientWriteBodyComplete schedules clientWriteComplete");
1481 clientWriteComplete(conn
, NULL
, size
, errflag
, xerrno
, data
);
1485 ConnStateData::readNextRequest()
1487 debugs(33, 5, HERE
<< clientConnection
<< " reading next req");
1489 fd_note(clientConnection
->fd
, "Idle client: Waiting for next request");
1491 * Set the timeout BEFORE calling clientReadRequest().
1493 typedef CommCbMemFunT
<ConnStateData
, CommTimeoutCbParams
> TimeoutDialer
;
1494 AsyncCall::Pointer timeoutCall
= JobCallback(33, 5,
1495 TimeoutDialer
, this, ConnStateData::requestTimeout
);
1496 commSetConnTimeout(clientConnection
, Config
.Timeout
.clientIdlePconn
, timeoutCall
);
1499 /** Please don't do anything with the FD past here! */
1503 ClientSocketContextPushDeferredIfNeeded(ClientSocketContext::Pointer deferredRequest
, ConnStateData
* conn
)
1505 debugs(33, 2, HERE
<< conn
->clientConnection
<< " Sending next");
1507 /** If the client stream is waiting on a socket write to occur, then */
1509 if (deferredRequest
->flags
.deferred
) {
1510 /** NO data is allowed to have been sent. */
1511 assert(deferredRequest
->http
->out
.size
== 0);
1513 clientSocketRecipient(deferredRequest
->deferredparams
.node
,
1514 deferredRequest
->http
,
1515 deferredRequest
->deferredparams
.rep
,
1516 deferredRequest
->deferredparams
.queuedBuffer
);
1519 /** otherwise, the request is still active in a callbacksomewhere,
1524 /// called when we have successfully finished writing the response
1526 ClientSocketContext::keepaliveNextRequest()
1528 ConnStateData
* conn
= http
->getConn();
1530 debugs(33, 3, HERE
<< "ConnnStateData(" << conn
->clientConnection
<< "), Context(" << clientConnection
<< ")");
1533 if (conn
->pinning
.pinned
&& !Comm::IsConnOpen(conn
->pinning
.serverConnection
)) {
1534 debugs(33, 2, HERE
<< conn
->clientConnection
<< " Connection was pinned but server side gone. Terminating client connection");
1535 conn
->clientConnection
->close();
1540 * We are done with the response, and we are either still receiving request
1541 * body (early response!) or have already stopped receiving anything.
1543 * If we are still receiving, then clientParseRequest() below will fail.
1544 * (XXX: but then we will call readNextRequest() which may succeed and
1545 * execute a smuggled request as we are not done with the current request).
1547 * If we stopped because we got everything, then try the next request.
1549 * If we stopped receiving because of an error, then close now to avoid
1550 * getting stuck and to prevent accidental request smuggling.
1553 if (const char *reason
= conn
->stoppedReceiving()) {
1554 debugs(33, 3, HERE
<< "closing for earlier request error: " << reason
);
1555 conn
->clientConnection
->close();
1560 * Attempt to parse a request from the request buffer.
1561 * If we've been fed a pipelined request it may already
1562 * be in our read buffer.
1565 * This needs to fall through - if we're unlucky and parse the _last_ request
1566 * from our read buffer we may never re-register for another client read.
1569 if (conn
->clientParseRequests()) {
1570 debugs(33, 3, HERE
<< conn
->clientConnection
<< ": parsed next request from buffer");
1574 * Either we need to kick-start another read or, if we have
1575 * a half-closed connection, kill it after the last request.
1576 * This saves waiting for half-closed connections to finished being
1577 * half-closed _AND_ then, sometimes, spending "Timeout" time in
1578 * the keepalive "Waiting for next request" state.
1580 if (commIsHalfClosed(conn
->clientConnection
->fd
) && (conn
->getConcurrentRequestCount() == 0)) {
1581 debugs(33, 3, "ClientSocketContext::keepaliveNextRequest: half-closed client with no pending requests, closing");
1582 conn
->clientConnection
->close();
1586 ClientSocketContext::Pointer deferredRequest
;
1589 * At this point we either have a parsed request (which we've
1590 * kicked off the processing for) or not. If we have a deferred
1591 * request (parsed but deferred for pipeling processing reasons)
1592 * then look at processing it. If not, simply kickstart
1596 if ((deferredRequest
= conn
->getCurrentContext()).getRaw()) {
1597 debugs(33, 3, HERE
<< conn
->clientConnection
<< ": calling PushDeferredIfNeeded");
1598 ClientSocketContextPushDeferredIfNeeded(deferredRequest
, conn
);
1599 } else if (conn
->flags
.readMore
) {
1600 debugs(33, 3, HERE
<< conn
->clientConnection
<< ": calling conn->readNextRequest()");
1601 conn
->readNextRequest();
1603 // XXX: Can this happen? CONNECT tunnels have deferredRequest set.
1604 debugs(33, DBG_IMPORTANT
, HERE
<< "abandoning " << conn
->clientConnection
);
1609 clientUpdateSocketStats(log_type logType
, size_t size
)
1614 kb_incr(&statCounter
.client_http
.kbytes_out
, size
);
1616 if (logTypeIsATcpHit(logType
))
1617 kb_incr(&statCounter
.client_http
.hit_kbytes_out
, size
);
1621 * increments iterator "i"
1622 * used by clientPackMoreRanges
1624 \retval true there is still data available to pack more ranges
1628 ClientSocketContext::canPackMoreRanges() const
1630 /** first update iterator "i" if needed */
1632 if (!http
->range_iter
.debt()) {
1633 debugs(33, 5, HERE
<< "At end of current range spec for " << clientConnection
);
1635 if (http
->range_iter
.pos
.incrementable())
1636 ++http
->range_iter
.pos
;
1638 http
->range_iter
.updateSpec();
1641 assert(!http
->range_iter
.debt() == !http
->range_iter
.currentSpec());
1643 /* paranoid sync condition */
1644 /* continue condition: need_more_data */
1645 debugs(33, 5, "ClientSocketContext::canPackMoreRanges: returning " << (http
->range_iter
.currentSpec() ? true : false));
1646 return http
->range_iter
.currentSpec() ? true : false;
1650 ClientSocketContext::getNextRangeOffset() const
1652 if (http
->request
->range
) {
1653 /* offset in range specs does not count the prefix of an http msg */
1654 debugs (33, 5, "ClientSocketContext::getNextRangeOffset: http offset " << http
->out
.offset
);
1655 /* check: reply was parsed and range iterator was initialized */
1656 assert(http
->range_iter
.valid
);
1657 /* filter out data according to range specs */
1658 assert (canPackMoreRanges());
1660 int64_t start
; /* offset of still missing data */
1661 assert(http
->range_iter
.currentSpec());
1662 start
= http
->range_iter
.currentSpec()->offset
+ http
->range_iter
.currentSpec()->length
- http
->range_iter
.debt();
1663 debugs(33, 3, "clientPackMoreRanges: in: offset: " << http
->out
.offset
);
1664 debugs(33, 3, "clientPackMoreRanges: out:"
1665 " start: " << start
<<
1666 " spec[" << http
->range_iter
.pos
- http
->request
->range
->begin() << "]:" <<
1667 " [" << http
->range_iter
.currentSpec()->offset
<<
1668 ", " << http
->range_iter
.currentSpec()->offset
+ http
->range_iter
.currentSpec()->length
<< "),"
1669 " len: " << http
->range_iter
.currentSpec()->length
<<
1670 " debt: " << http
->range_iter
.debt());
1671 if (http
->range_iter
.currentSpec()->length
!= -1)
1672 assert(http
->out
.offset
<= start
); /* we did not miss it */
1677 } else if (reply
&& reply
->content_range
) {
1678 /* request does not have ranges, but reply does */
1679 /** \todo FIXME: should use range_iter_pos on reply, as soon as reply->content_range
1680 * becomes HttpHdrRange rather than HttpHdrRangeSpec.
1682 return http
->out
.offset
+ reply
->content_range
->spec
.offset
;
1685 return http
->out
.offset
;
1689 ClientSocketContext::pullData()
1691 debugs(33, 5, HERE
<< clientConnection
<< " attempting to pull upstream data");
1693 /* More data will be coming from the stream. */
1694 StoreIOBuffer readBuffer
;
1695 /* XXX: Next requested byte in the range sequence */
1696 /* XXX: length = getmaximumrangelenfgth */
1697 readBuffer
.offset
= getNextRangeOffset();
1698 readBuffer
.length
= HTTP_REQBUF_SZ
;
1699 readBuffer
.data
= reqbuf
;
1700 /* we may note we have reached the end of the wanted ranges */
1701 clientStreamRead(getTail(), http
, readBuffer
);
1704 clientStream_status_t
1705 ClientSocketContext::socketState()
1707 switch (clientStreamStatus(getTail(), http
)) {
1710 /* check for range support ending */
1712 if (http
->request
->range
) {
1713 /* check: reply was parsed and range iterator was initialized */
1714 assert(http
->range_iter
.valid
);
1715 /* filter out data according to range specs */
1717 if (!canPackMoreRanges()) {
1718 debugs(33, 5, HERE
<< "Range request at end of returnable " <<
1719 "range sequence on " << clientConnection
);
1721 if (http
->request
->flags
.proxy_keepalive
)
1722 return STREAM_COMPLETE
;
1724 return STREAM_UNPLANNED_COMPLETE
;
1726 } else if (reply
&& reply
->content_range
) {
1727 /* reply has content-range, but Squid is not managing ranges */
1728 const int64_t &bytesSent
= http
->out
.offset
;
1729 const int64_t &bytesExpected
= reply
->content_range
->spec
.length
;
1731 debugs(33, 7, HERE
<< "body bytes sent vs. expected: " <<
1732 bytesSent
<< " ? " << bytesExpected
<< " (+" <<
1733 reply
->content_range
->spec
.offset
<< ")");
1735 // did we get at least what we expected, based on range specs?
1737 if (bytesSent
== bytesExpected
) { // got everything
1738 if (http
->request
->flags
.proxy_keepalive
)
1739 return STREAM_COMPLETE
;
1741 return STREAM_UNPLANNED_COMPLETE
;
1744 // The logic below is not clear: If we got more than we
1745 // expected why would persistency matter? Should not this
1746 // always be an error?
1747 if (bytesSent
> bytesExpected
) { // got extra
1748 if (http
->request
->flags
.proxy_keepalive
)
1749 return STREAM_COMPLETE
;
1751 return STREAM_UNPLANNED_COMPLETE
;
1754 // did not get enough yet, expecting more
1759 case STREAM_COMPLETE
:
1760 return STREAM_COMPLETE
;
1762 case STREAM_UNPLANNED_COMPLETE
:
1763 return STREAM_UNPLANNED_COMPLETE
;
1766 return STREAM_FAILED
;
1769 fatal ("unreachable code\n");
1774 * A write has just completed to the client, or we have just realised there is
1775 * no more data to send.
1778 clientWriteComplete(const Comm::ConnectionPointer
&conn
, char *bufnotused
, size_t size
, comm_err_t errflag
, int xerrno
, void *data
)
1780 ClientSocketContext
*context
= (ClientSocketContext
*)data
;
1781 context
->writeComplete(conn
, bufnotused
, size
, errflag
);
1784 /// remembers the abnormal connection termination for logging purposes
1786 ClientSocketContext::noteIoError(const int xerrno
)
1789 if (xerrno
== ETIMEDOUT
)
1790 http
->al
.http
.timedout
= true;
1791 else // even if xerrno is zero (which means read abort/eof)
1792 http
->al
.http
.aborted
= true;
1798 ClientSocketContext::doClose()
1800 clientConnection
->close();
1803 /// called when we encounter a response-related error
1805 ClientSocketContext::initiateClose(const char *reason
)
1807 http
->getConn()->stopSending(reason
); // closes ASAP
1811 ConnStateData::stopSending(const char *error
)
1813 debugs(33, 4, HERE
<< "sending error (" << clientConnection
<< "): " << error
<<
1814 "; old receiving error: " <<
1815 (stoppedReceiving() ? stoppedReceiving_
: "none"));
1817 if (const char *oldError
= stoppedSending()) {
1818 debugs(33, 3, HERE
<< "already stopped sending: " << oldError
);
1819 return; // nothing has changed as far as this connection is concerned
1821 stoppedSending_
= error
;
1823 if (!stoppedReceiving()) {
1824 if (const int64_t expecting
= mayNeedToReadMoreBody()) {
1825 debugs(33, 5, HERE
<< "must still read " << expecting
<<
1826 " request body bytes with " << in
.notYetUsed
<< " unused");
1827 return; // wait for the request receiver to finish reading
1831 clientConnection
->close();
1835 ClientSocketContext::writeComplete(const Comm::ConnectionPointer
&conn
, char *bufnotused
, size_t size
, comm_err_t errflag
)
1837 const StoreEntry
*entry
= http
->storeEntry();
1838 http
->out
.size
+= size
;
1839 debugs(33, 5, HERE
<< conn
<< ", sz " << size
<<
1840 ", err " << errflag
<< ", off " << http
->out
.size
<< ", len " <<
1841 (entry
? entry
->objectLen() : 0));
1842 clientUpdateSocketStats(http
->logType
, size
);
1844 /* Bail out quickly on COMM_ERR_CLOSING - close handlers will tidy up */
1846 if (errflag
== COMM_ERR_CLOSING
|| !Comm::IsConnOpen(conn
))
1849 if (errflag
|| clientHttpRequestStatus(conn
->fd
, http
)) {
1850 initiateClose("failure or true request status");
1851 /* Do we leak here ? */
1855 switch (socketState()) {
1861 case STREAM_COMPLETE
:
1862 debugs(33, 5, HERE
<< conn
<< " Keeping Alive");
1863 keepaliveNextRequest();
1866 case STREAM_UNPLANNED_COMPLETE
:
1867 initiateClose("STREAM_UNPLANNED_COMPLETE");
1871 initiateClose("STREAM_FAILED");
1875 fatal("Hit unreachable code in clientWriteComplete\n");
1879 extern "C" CSR clientGetMoreData
;
1880 extern "C" CSS clientReplyStatus
;
1881 extern "C" CSD clientReplyDetach
;
1883 static ClientSocketContext
*
1884 parseHttpRequestAbort(ConnStateData
* csd
, const char *uri
)
1886 ClientHttpRequest
*http
;
1887 ClientSocketContext
*context
;
1888 StoreIOBuffer tempBuffer
;
1889 http
= new ClientHttpRequest(csd
);
1890 http
->req_sz
= csd
->in
.notYetUsed
;
1891 http
->uri
= xstrdup(uri
);
1892 setLogUri (http
, uri
);
1893 context
= ClientSocketContextNew(csd
->clientConnection
, http
);
1894 tempBuffer
.data
= context
->reqbuf
;
1895 tempBuffer
.length
= HTTP_REQBUF_SZ
;
1896 clientStreamInit(&http
->client_stream
, clientGetMoreData
, clientReplyDetach
,
1897 clientReplyStatus
, new clientReplyContext(http
), clientSocketRecipient
,
1898 clientSocketDetach
, context
, tempBuffer
);
1903 skipLeadingSpace(char *aString
)
1905 char *result
= aString
;
1907 while (xisspace(*aString
))
1914 * 'end' defaults to NULL for backwards compatibility
1915 * remove default value if we ever get rid of NULL-terminated
1919 findTrailingHTTPVersion(const char *uriAndHTTPVersion
, const char *end
)
1922 end
= uriAndHTTPVersion
+ strcspn(uriAndHTTPVersion
, "\r\n");
1926 for (; end
> uriAndHTTPVersion
; end
--) {
1927 if (*end
== '\n' || *end
== '\r')
1930 if (xisspace(*end
)) {
1931 if (strncasecmp(end
+ 1, "HTTP/", 5) == 0)
1942 setLogUri(ClientHttpRequest
* http
, char const *uri
, bool cleanUrl
)
1944 safe_free(http
->log_uri
);
1947 // The uri is already clean just dump it.
1948 http
->log_uri
= xstrndup(uri
, MAX_URL
);
1951 switch (Config
.uri_whitespace
) {
1952 case URI_WHITESPACE_ALLOW
:
1953 flags
|= RFC1738_ESCAPE_NOSPACE
;
1955 case URI_WHITESPACE_ENCODE
:
1956 flags
|= RFC1738_ESCAPE_UNESCAPED
;
1957 http
->log_uri
= xstrndup(rfc1738_do_escape(uri
, flags
), MAX_URL
);
1960 case URI_WHITESPACE_CHOP
: {
1961 flags
|= RFC1738_ESCAPE_NOSPACE
;
1962 flags
|= RFC1738_ESCAPE_UNESCAPED
;
1963 http
->log_uri
= xstrndup(rfc1738_do_escape(uri
, flags
), MAX_URL
);
1964 int pos
= strcspn(http
->log_uri
, w_space
);
1965 http
->log_uri
[pos
] = '\0';
1969 case URI_WHITESPACE_DENY
:
1970 case URI_WHITESPACE_STRIP
:
1973 char *tmp_uri
= static_cast<char*>(xmalloc(strlen(uri
) + 1));
1982 http
->log_uri
= xstrndup(rfc1738_escape_unescaped(tmp_uri
), MAX_URL
);
1991 prepareAcceleratedURL(ConnStateData
* conn
, ClientHttpRequest
*http
, char *url
, const char *req_hdr
)
1993 int vhost
= conn
->port
->vhost
;
1994 int vport
= conn
->port
->vport
;
1996 char ipbuf
[MAX_IPSTRLEN
];
1998 http
->flags
.accel
= 1;
2000 /* BUG: Squid cannot deal with '*' URLs (RFC2616 5.1.2) */
2002 if (strncasecmp(url
, "cache_object://", 15) == 0)
2003 return; /* already in good shape */
2006 if (conn
->port
->vhost
)
2007 return; /* already in good shape */
2009 /* else we need to ignore the host name */
2010 url
= strstr(url
, "//");
2012 #if SHOULD_REJECT_UNKNOWN_URLS
2015 hp
->request_parse_status
= HTTP_BAD_REQUEST
;
2016 return parseHttpRequestAbort(conn
, "error:invalid-request");
2021 url
= strchr(url
+ 2, '/');
2028 vport
= http
->getConn()->clientConnection
->local
.GetPort();
2030 const bool switchedToHttps
= conn
->switchedToHttps();
2031 const bool tryHostHeader
= vhost
|| switchedToHttps
;
2032 if (tryHostHeader
&& (host
= mime_get_header(req_hdr
, "Host")) != NULL
) {
2033 debugs(33, 5, "ACCEL VHOST REWRITE: vhost=" << host
<< " + vport=" << vport
);
2038 if (host
[strlen(host
)] != ']' && (t
= strrchr(host
,':')) != NULL
) {
2039 strncpy(thost
, host
, (t
-host
));
2040 snprintf(thost
+(t
-host
), sizeof(thost
)-(t
-host
), ":%d", vport
);
2043 snprintf(thost
, sizeof(thost
), "%s:%d",host
, vport
);
2046 } // else nothing to alter port-wise.
2047 int url_sz
= strlen(url
) + 32 + Config
.appendDomainLen
+
2049 http
->uri
= (char *)xcalloc(url_sz
, 1);
2050 const char *protocol
= switchedToHttps
?
2051 "https" : conn
->port
->protocol
;
2052 snprintf(http
->uri
, url_sz
, "%s://%s%s", protocol
, host
, url
);
2053 debugs(33, 5, "ACCEL VHOST REWRITE: '" << http
->uri
<< "'");
2054 } else if (conn
->port
->defaultsite
/* && !vhost */) {
2055 debugs(33, 5, "ACCEL DEFAULTSITE REWRITE: defaultsite=" << conn
->port
->defaultsite
<< " + vport=" << vport
);
2056 int url_sz
= strlen(url
) + 32 + Config
.appendDomainLen
+
2057 strlen(conn
->port
->defaultsite
);
2058 http
->uri
= (char *)xcalloc(url_sz
, 1);
2062 snprintf(vportStr
, sizeof(vportStr
),":%d",vport
);
2064 snprintf(http
->uri
, url_sz
, "%s://%s%s%s",
2065 conn
->port
->protocol
, conn
->port
->defaultsite
, vportStr
, url
);
2066 debugs(33, 5, "ACCEL DEFAULTSITE REWRITE: '" << http
->uri
<<"'");
2067 } else if (vport
> 0 /* && (!vhost || no Host:) */) {
2068 debugs(33, 5, "ACCEL VPORT REWRITE: http_port IP + vport=" << vport
);
2069 /* Put the local socket IP address as the hostname, with whatever vport we found */
2070 int url_sz
= strlen(url
) + 32 + Config
.appendDomainLen
;
2071 http
->uri
= (char *)xcalloc(url_sz
, 1);
2072 http
->getConn()->clientConnection
->local
.ToHostname(ipbuf
,MAX_IPSTRLEN
);
2073 snprintf(http
->uri
, url_sz
, "%s://%s:%d%s",
2074 http
->getConn()->port
->protocol
,
2076 debugs(33, 5, "ACCEL VPORT REWRITE: '" << http
->uri
<< "'");
2081 prepareTransparentURL(ConnStateData
* conn
, ClientHttpRequest
*http
, char *url
, const char *req_hdr
)
2084 char ipbuf
[MAX_IPSTRLEN
];
2087 return; /* already in good shape */
2089 /* BUG: Squid cannot deal with '*' URLs (RFC2616 5.1.2) */
2090 // BUG 2976: Squid only accepts intercepted HTTP.
2092 if ((host
= mime_get_header(req_hdr
, "Host")) != NULL
) {
2093 int url_sz
= strlen(url
) + 32 + Config
.appendDomainLen
+
2095 http
->uri
= (char *)xcalloc(url_sz
, 1);
2096 snprintf(http
->uri
, url_sz
, "http://%s%s", /*conn->port->protocol,*/ host
, url
);
2097 debugs(33, 5, "TRANSPARENT HOST REWRITE: '" << http
->uri
<<"'");
2099 /* Put the local socket IP address as the hostname. */
2100 int url_sz
= strlen(url
) + 32 + Config
.appendDomainLen
;
2101 http
->uri
= (char *)xcalloc(url_sz
, 1);
2102 http
->getConn()->clientConnection
->local
.ToHostname(ipbuf
,MAX_IPSTRLEN
),
2103 snprintf(http
->uri
, url_sz
, "http://%s:%d%s",
2104 // http->getConn()->port->protocol,
2105 ipbuf
, http
->getConn()->clientConnection
->local
.GetPort(), url
);
2106 debugs(33, 5, "TRANSPARENT REWRITE: '" << http
->uri
<< "'");
2111 * parseHttpRequest()
2114 * NULL on incomplete requests
2115 * a ClientSocketContext structure on success or failure.
2116 * Sets result->flags.parsed_ok to 0 if failed to parse the request.
2117 * Sets result->flags.parsed_ok to 1 if we have a good request.
2119 static ClientSocketContext
*
2120 parseHttpRequest(ConnStateData
*csd
, HttpParser
*hp
, HttpRequestMethod
* method_p
, HttpVersion
*http_ver
)
2122 char *req_hdr
= NULL
;
2125 ClientHttpRequest
*http
;
2126 ClientSocketContext
*result
;
2127 StoreIOBuffer tempBuffer
;
2130 /* pre-set these values to make aborting simpler */
2131 *method_p
= METHOD_NONE
;
2133 /* NP: don't be tempted to move this down or remove again.
2134 * It's the only DDoS protection old-String has against long URL */
2135 if ( hp
->bufsiz
<= 0) {
2136 debugs(33, 5, "Incomplete request, waiting for end of request line");
2138 } else if ( (size_t)hp
->bufsiz
>= Config
.maxRequestHeaderSize
&& headersEnd(hp
->buf
, Config
.maxRequestHeaderSize
) == 0) {
2139 debugs(33, 5, "parseHttpRequest: Too large request");
2140 hp
->request_parse_status
= HTTP_HEADER_TOO_LARGE
;
2141 return parseHttpRequestAbort(csd
, "error:request-too-large");
2144 /* Attempt to parse the first line; this'll define the method, url, version and header begin */
2145 r
= HttpParserParseReqLine(hp
);
2148 debugs(33, 5, "Incomplete request, waiting for end of request line");
2153 return parseHttpRequestAbort(csd
, "error:invalid-request");
2156 /* Request line is valid here .. */
2157 *http_ver
= HttpVersion(hp
->req
.v_maj
, hp
->req
.v_min
);
2159 /* This call scans the entire request, not just the headers */
2160 if (hp
->req
.v_maj
> 0) {
2161 if ((req_sz
= headersEnd(hp
->buf
, hp
->bufsiz
)) == 0) {
2162 debugs(33, 5, "Incomplete request, waiting for end of headers");
2166 debugs(33, 3, "parseHttpRequest: Missing HTTP identifier");
2167 req_sz
= HttpParserReqSz(hp
);
2170 /* We know the whole request is in hp->buf now */
2172 assert(req_sz
<= (size_t) hp
->bufsiz
);
2174 /* Will the following be true with HTTP/0.9 requests? probably not .. */
2175 /* So the rest of the code will need to deal with '0'-byte headers (ie, none, so don't try parsing em) */
2178 hp
->hdr_end
= req_sz
- 1;
2180 hp
->hdr_start
= hp
->req
.end
+ 1;
2182 /* Enforce max_request_size */
2183 if (req_sz
>= Config
.maxRequestHeaderSize
) {
2184 debugs(33, 5, "parseHttpRequest: Too large request");
2185 hp
->request_parse_status
= HTTP_HEADER_TOO_LARGE
;
2186 return parseHttpRequestAbort(csd
, "error:request-too-large");
2190 *method_p
= HttpRequestMethod(&hp
->buf
[hp
->req
.m_start
], &hp
->buf
[hp
->req
.m_end
]+1);
2192 /* deny CONNECT via accelerated ports */
2193 if (*method_p
== METHOD_CONNECT
&& csd
&& csd
->port
&& csd
->port
->accel
) {
2194 debugs(33, DBG_IMPORTANT
, "WARNING: CONNECT method received on " << csd
->port
->protocol
<< " Accelerator port " << csd
->port
->s
.GetPort() );
2195 /* XXX need a way to say "this many character length string" */
2196 debugs(33, DBG_IMPORTANT
, "WARNING: for request: " << hp
->buf
);
2197 hp
->request_parse_status
= HTTP_METHOD_NOT_ALLOWED
;
2198 return parseHttpRequestAbort(csd
, "error:method-not-allowed");
2201 if (*method_p
== METHOD_NONE
) {
2202 /* XXX need a way to say "this many character length string" */
2203 debugs(33, 1, "clientParseRequestMethod: Unsupported method in request '" << hp
->buf
<< "'");
2204 hp
->request_parse_status
= HTTP_METHOD_NOT_ALLOWED
;
2205 return parseHttpRequestAbort(csd
, "error:unsupported-request-method");
2209 * Process headers after request line
2210 * TODO: Use httpRequestParse here.
2212 /* XXX this code should be modified to take a const char * later! */
2213 req_hdr
= (char *) hp
->buf
+ hp
->req
.end
+ 1;
2215 debugs(33, 3, "parseHttpRequest: req_hdr = {" << req_hdr
<< "}");
2217 end
= (char *) hp
->buf
+ hp
->hdr_end
;
2219 debugs(33, 3, "parseHttpRequest: end = {" << end
<< "}");
2221 debugs(33, 3, "parseHttpRequest: prefix_sz = " <<
2222 (int) HttpParserRequestLen(hp
) << ", req_line_sz = " <<
2223 HttpParserReqSz(hp
));
2225 /* Ok, all headers are received */
2226 http
= new ClientHttpRequest(csd
);
2228 http
->req_sz
= HttpParserRequestLen(hp
);
2229 result
= ClientSocketContextNew(csd
->clientConnection
, http
);
2230 tempBuffer
.data
= result
->reqbuf
;
2231 tempBuffer
.length
= HTTP_REQBUF_SZ
;
2233 ClientStreamData newServer
= new clientReplyContext(http
);
2234 ClientStreamData newClient
= result
;
2235 clientStreamInit(&http
->client_stream
, clientGetMoreData
, clientReplyDetach
,
2236 clientReplyStatus
, newServer
, clientSocketRecipient
,
2237 clientSocketDetach
, newClient
, tempBuffer
);
2239 debugs(33, 5, "parseHttpRequest: Request Header is\n" <<(hp
->buf
) + hp
->hdr_start
);
2243 * XXX this should eventually not use a malloc'ed buffer; the transformation code
2244 * below needs to be modified to not expect a mutable nul-terminated string.
2246 char *url
= (char *)xmalloc(hp
->req
.u_end
- hp
->req
.u_start
+ 16);
2248 memcpy(url
, hp
->buf
+ hp
->req
.u_start
, hp
->req
.u_end
- hp
->req
.u_start
+ 1);
2250 url
[hp
->req
.u_end
- hp
->req
.u_start
+ 1] = '\0';
2252 #if THIS_VIOLATES_HTTP_SPECS_ON_URL_TRANSFORMATION
2254 if ((t
= strchr(url
, '#'))) /* remove HTML anchors */
2259 debugs(33,5, HERE
<< "repare absolute URL from " << (csd
->transparent()?"intercept":(csd
->port
->accel
? "accel":"")));
2260 /* Rewrite the URL in transparent or accelerator mode */
2261 /* NP: there are several cases to traverse here:
2262 * - standard mode (forward proxy)
2263 * - transparent mode (TPROXY)
2264 * - transparent mode with failures
2265 * - intercept mode (NAT)
2266 * - intercept mode with failures
2267 * - accelerator mode (reverse proxy)
2269 * - mixed combos of the above with internal URL
2271 if (csd
->transparent()) {
2272 /* intercept or transparent mode, properly working with no failures */
2273 prepareTransparentURL(csd
, http
, url
, req_hdr
);
2275 } else if (internalCheck(url
)) {
2276 /* internal URL mode */
2277 /* prepend our name & port */
2278 http
->uri
= xstrdup(internalLocalUri(NULL
, url
));
2279 // We just re-wrote the URL. Must replace the Host: header.
2280 // But have not parsed there yet!! flag for local-only handling.
2281 http
->flags
.internal
= 1;
2283 } else if (csd
->port
->accel
|| csd
->switchedToHttps()) {
2284 /* accelerator mode */
2285 prepareAcceleratedURL(csd
, http
, url
, req_hdr
);
2289 /* No special rewrites have been applied above, use the
2290 * requested url. may be rewritten later, so make extra room */
2291 int url_sz
= strlen(url
) + Config
.appendDomainLen
+ 5;
2292 http
->uri
= (char *)xcalloc(url_sz
, 1);
2293 strcpy(http
->uri
, url
);
2296 debugs(33, 5, "parseHttpRequest: Complete request received");
2298 // XXX: crop this dump at the end of headers. No need for extras
2299 debugs(11, 2, "HTTP Client " << csd
->clientConnection
);
2300 debugs(11, 2, "HTTP Client REQUEST:\n---------\n" << (hp
->buf
) + hp
->req
.m_start
<< "\n----------");
2302 result
->flags
.parsed_ok
= 1;
2308 ConnStateData::getAvailableBufferLength() const
2310 assert (in
.allocatedSize
> in
.notYetUsed
); // allocated more than used
2311 const size_t result
= in
.allocatedSize
- in
.notYetUsed
- 1;
2312 // huge request_header_max_size may lead to more than INT_MAX unused space
2313 assert (static_cast<ssize_t
>(result
) <= INT_MAX
);
2318 ConnStateData::maybeMakeSpaceAvailable()
2320 if (getAvailableBufferLength() < 2) {
2322 if (in
.allocatedSize
>= Config
.maxRequestBufferSize
) {
2323 debugs(33, 4, "request buffer full: client_request_buffer_max_size=" << Config
.maxRequestBufferSize
);
2326 if ((newSize
=in
.allocatedSize
* 2) > Config
.maxRequestBufferSize
) {
2327 newSize
=Config
.maxRequestBufferSize
;
2329 in
.buf
= (char *)memReallocBuf(in
.buf
, newSize
, &in
.allocatedSize
);
2330 debugs(33, 2, "growing request buffer: notYetUsed=" << in
.notYetUsed
<< " size=" << in
.allocatedSize
);
2336 ConnStateData::addContextToQueue(ClientSocketContext
* context
)
2338 ClientSocketContext::Pointer
*S
;
2340 for (S
= (ClientSocketContext::Pointer
*) & currentobject
; S
->getRaw();
2348 ConnStateData::getConcurrentRequestCount() const
2351 ClientSocketContext::Pointer
*T
;
2353 for (T
= (ClientSocketContext::Pointer
*) ¤tobject
;
2354 T
->getRaw(); T
= &(*T
)->next
, ++result
);
2359 ConnStateData::connReadWasError(comm_err_t flag
, int size
, int xerrno
)
2361 if (flag
!= COMM_OK
) {
2362 debugs(33, 2, "connReadWasError: FD " << clientConnection
<< ": got flag " << flag
);
2367 if (!ignoreErrno(xerrno
)) {
2368 debugs(33, 2, "connReadWasError: FD " << clientConnection
<< ": " << xstrerr(xerrno
));
2370 } else if (in
.notYetUsed
== 0) {
2371 debugs(33, 2, "connReadWasError: FD " << clientConnection
<< ": no data to process (" << xstrerr(xerrno
) << ")");
2379 ConnStateData::connFinishedWithConn(int size
)
2382 if (getConcurrentRequestCount() == 0 && in
.notYetUsed
== 0) {
2383 /* no current or pending requests */
2384 debugs(33, 4, HERE
<< clientConnection
<< " closed");
2386 } else if (!Config
.onoff
.half_closed_clients
) {
2387 /* admin doesn't want to support half-closed client sockets */
2388 debugs(33, 3, HERE
<< clientConnection
<< " aborted (half_closed_clients disabled)");
2389 notifyAllContexts(0); // no specific error implies abort
2398 connNoteUseOfBuffer(ConnStateData
* conn
, size_t byteCount
)
2400 assert(byteCount
> 0 && byteCount
<= conn
->in
.notYetUsed
);
2401 conn
->in
.notYetUsed
-= byteCount
;
2402 debugs(33, 5, HERE
<< "conn->in.notYetUsed = " << conn
->in
.notYetUsed
);
2404 * If there is still data that will be used,
2405 * move it to the beginning.
2408 if (conn
->in
.notYetUsed
> 0)
2409 memmove(conn
->in
.buf
, conn
->in
.buf
+ byteCount
, conn
->in
.notYetUsed
);
2412 /// respond with ERR_TOO_BIG if request header exceeds request_header_max_size
2414 ConnStateData::checkHeaderLimits()
2416 if (in
.notYetUsed
< Config
.maxRequestHeaderSize
)
2417 return; // can accumulte more header data
2419 debugs(33, 3, "Request header is too large (" << in
.notYetUsed
<< " > " <<
2420 Config
.maxRequestHeaderSize
<< " bytes)");
2422 ClientSocketContext
*context
= parseHttpRequestAbort(this, "error:request-too-large");
2423 clientStreamNode
*node
= context
->getClientReplyContext();
2424 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2425 assert (repContext
);
2426 repContext
->setReplyToError(ERR_TOO_BIG
,
2427 HTTP_BAD_REQUEST
, METHOD_NONE
, NULL
,
2428 clientConnection
->remote
, NULL
, NULL
, NULL
);
2429 context
->registerWithConn();
2430 context
->pullData();
2434 ConnStateData::clientAfterReadingRequests()
2436 // Were we expecting to read more request body from half-closed connection?
2437 if (mayNeedToReadMoreBody() && commIsHalfClosed(clientConnection
->fd
)) {
2438 debugs(33, 3, HERE
<< "truncated body: closing half-closed " << clientConnection
);
2439 clientConnection
->close();
2448 clientProcessRequest(ConnStateData
*conn
, HttpParser
*hp
, ClientSocketContext
*context
, const HttpRequestMethod
& method
, HttpVersion http_ver
)
2450 ClientHttpRequest
*http
= context
->http
;
2451 HttpRequest
*request
= NULL
;
2452 bool notedUseOfBuffer
= false;
2453 bool chunked
= false;
2454 bool mustReplyToOptions
= false;
2455 bool unsupportedTe
= false;
2456 bool expectBody
= false;
2458 /* We have an initial client stream in place should it be needed */
2459 /* setup our private context */
2460 context
->registerWithConn();
2462 if (context
->flags
.parsed_ok
== 0) {
2463 clientStreamNode
*node
= context
->getClientReplyContext();
2464 debugs(33, 2, "clientProcessRequest: Invalid Request");
2465 // setLogUri should called before repContext->setReplyToError
2466 setLogUri(http
, http
->uri
, true);
2467 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2468 assert (repContext
);
2469 switch (hp
->request_parse_status
) {
2470 case HTTP_HEADER_TOO_LARGE
:
2471 repContext
->setReplyToError(ERR_TOO_BIG
, HTTP_BAD_REQUEST
, method
, http
->uri
, conn
->clientConnection
->remote
, NULL
, conn
->in
.buf
, NULL
);
2473 case HTTP_METHOD_NOT_ALLOWED
:
2474 repContext
->setReplyToError(ERR_UNSUP_REQ
, HTTP_METHOD_NOT_ALLOWED
, method
, http
->uri
,
2475 conn
->clientConnection
->remote
, NULL
, conn
->in
.buf
, NULL
);
2478 repContext
->setReplyToError(ERR_INVALID_REQ
, hp
->request_parse_status
, method
, http
->uri
,
2479 conn
->clientConnection
->remote
, NULL
, conn
->in
.buf
, NULL
);
2481 assert(context
->http
->out
.offset
== 0);
2482 context
->pullData();
2483 conn
->flags
.readMore
= false;
2487 if ((request
= HttpRequest::CreateFromUrlAndMethod(http
->uri
, method
)) == NULL
) {
2488 clientStreamNode
*node
= context
->getClientReplyContext();
2489 debugs(33, 5, "Invalid URL: " << http
->uri
);
2490 // setLogUri should called before repContext->setReplyToError
2491 setLogUri(http
, http
->uri
, true);
2492 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2493 assert (repContext
);
2494 repContext
->setReplyToError(ERR_INVALID_URL
, HTTP_BAD_REQUEST
, method
, http
->uri
, conn
->clientConnection
->remote
, NULL
, NULL
, NULL
);
2495 assert(context
->http
->out
.offset
== 0);
2496 context
->pullData();
2497 conn
->flags
.readMore
= false;
2501 /* RFC 2616 section 10.5.6 : handle unsupported HTTP versions cleanly. */
2502 /* We currently only accept 0.9, 1.0, 1.1 */
2503 if ( (http_ver
.major
== 0 && http_ver
.minor
!= 9) ||
2504 (http_ver
.major
== 1 && http_ver
.minor
> 1 ) ||
2505 (http_ver
.major
> 1) ) {
2507 clientStreamNode
*node
= context
->getClientReplyContext();
2508 debugs(33, 5, "Unsupported HTTP version discovered. :\n" << HttpParserHdrBuf(hp
));
2509 // setLogUri should called before repContext->setReplyToError
2510 setLogUri(http
, http
->uri
, true);
2511 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2512 assert (repContext
);
2513 repContext
->setReplyToError(ERR_UNSUP_HTTPVERSION
, HTTP_HTTP_VERSION_NOT_SUPPORTED
, method
, http
->uri
,
2514 conn
->clientConnection
->remote
, NULL
, HttpParserHdrBuf(hp
), NULL
);
2515 assert(context
->http
->out
.offset
== 0);
2516 context
->pullData();
2517 conn
->flags
.readMore
= false;
2521 /* compile headers */
2522 /* we should skip request line! */
2523 /* XXX should actually know the damned buffer size here */
2524 if (http_ver
.major
>= 1 && !request
->parseHeader(HttpParserHdrBuf(hp
), HttpParserHdrSz(hp
))) {
2525 clientStreamNode
*node
= context
->getClientReplyContext();
2526 debugs(33, 5, "Failed to parse request headers:\n" << HttpParserHdrBuf(hp
));
2527 // setLogUri should called before repContext->setReplyToError
2528 setLogUri(http
, http
->uri
, true);
2529 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2530 assert (repContext
);
2531 repContext
->setReplyToError(ERR_INVALID_REQ
, HTTP_BAD_REQUEST
, method
, http
->uri
, conn
->clientConnection
->remote
, NULL
, NULL
, NULL
);
2532 assert(context
->http
->out
.offset
== 0);
2533 context
->pullData();
2534 conn
->flags
.readMore
= false;
2538 request
->clientConnectionManager
= conn
;
2540 request
->flags
.accelerated
= http
->flags
.accel
;
2541 request
->flags
.sslBumped
= conn
->switchedToHttps();
2542 request
->flags
.ignore_cc
= conn
->port
->ignore_cc
;
2543 request
->flags
.no_direct
= request
->flags
.accelerated
? !conn
->port
->allow_direct
: 0;
2545 if (request
->flags
.sslBumped
) {
2546 if (conn
->auth_user_request
!= NULL
)
2547 request
->auth_user_request
= conn
->auth_user_request
;
2552 * If transparent or interception mode is working clone the transparent and interception flags
2553 * from the port settings to the request.
2555 if (http
->clientConnection
!= NULL
) {
2556 request
->flags
.intercepted
= ((http
->clientConnection
->flags
& COMM_INTERCEPTION
) != 0);
2557 request
->flags
.spoof_client_ip
= ((http
->clientConnection
->flags
& COMM_TRANSPARENT
) != 0 ) ;
2560 if (internalCheck(request
->urlpath
.termedBuf())) {
2561 if (internalHostnameIs(request
->GetHost()) &&
2562 request
->port
== getMyPort()) {
2563 http
->flags
.internal
= 1;
2564 } else if (Config
.onoff
.global_internal_static
&& internalStaticCheck(request
->urlpath
.termedBuf())) {
2565 request
->SetHost(internalHostname());
2566 request
->port
= getMyPort();
2567 http
->flags
.internal
= 1;
2571 if (http
->flags
.internal
) {
2572 request
->protocol
= AnyP::PROTO_HTTP
;
2573 request
->login
[0] = '\0';
2576 request
->flags
.internal
= http
->flags
.internal
;
2577 setLogUri (http
, urlCanonicalClean(request
));
2578 request
->client_addr
= conn
->clientConnection
->remote
; // XXX: remove reuest->client_addr member.
2579 #if FOLLOW_X_FORWARDED_FOR
2580 // indirect client gets stored here because it is an HTTP header result (from X-Forwarded-For:)
2581 // not a details about teh TCP connection itself
2582 request
->indirect_client_addr
= conn
->clientConnection
->remote
;
2583 #endif /* FOLLOW_X_FORWARDED_FOR */
2584 request
->my_addr
= conn
->clientConnection
->local
;
2585 request
->myportname
= conn
->port
->name
;
2586 request
->http_ver
= http_ver
;
2588 // Link this HttpRequest to ConnStateData relatively early so the following complex handling can use it
2589 // TODO: this effectively obsoletes a lot of conn->FOO copying. That needs cleaning up later.
2590 request
->clientConnectionManager
= conn
;
2592 if (request
->header
.chunked()) {
2594 } else if (request
->header
.has(HDR_TRANSFER_ENCODING
)) {
2595 const String te
= request
->header
.getList(HDR_TRANSFER_ENCODING
);
2596 // HTTP/1.1 requires chunking to be the last encoding if there is one
2597 unsupportedTe
= te
.size() && te
!= "identity";
2598 } // else implied identity coding
2600 mustReplyToOptions
= (method
== METHOD_OPTIONS
) &&
2601 (request
->header
.getInt64(HDR_MAX_FORWARDS
) == 0);
2602 if (!urlCheckRequest(request
) || mustReplyToOptions
|| unsupportedTe
) {
2603 clientStreamNode
*node
= context
->getClientReplyContext();
2604 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2605 assert (repContext
);
2606 repContext
->setReplyToError(ERR_UNSUP_REQ
, HTTP_NOT_IMPLEMENTED
, request
->method
, NULL
,
2607 conn
->clientConnection
->remote
, request
, NULL
, NULL
);
2608 assert(context
->http
->out
.offset
== 0);
2609 context
->pullData();
2610 conn
->flags
.readMore
= false;
2615 if (!chunked
&& !clientIsContentLengthValid(request
)) {
2616 clientStreamNode
*node
= context
->getClientReplyContext();
2617 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2618 assert (repContext
);
2619 repContext
->setReplyToError(ERR_INVALID_REQ
,
2620 HTTP_LENGTH_REQUIRED
, request
->method
, NULL
,
2621 conn
->clientConnection
->remote
, request
, NULL
, NULL
);
2622 assert(context
->http
->out
.offset
== 0);
2623 context
->pullData();
2624 conn
->flags
.readMore
= false;
2628 if (request
->header
.has(HDR_EXPECT
)) {
2629 const String expect
= request
->header
.getList(HDR_EXPECT
);
2630 const bool supportedExpect
= (expect
.caseCmp("100-continue") == 0);
2631 if (!supportedExpect
) {
2632 clientStreamNode
*node
= context
->getClientReplyContext();
2633 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2634 assert (repContext
);
2635 repContext
->setReplyToError(ERR_INVALID_REQ
, HTTP_EXPECTATION_FAILED
, request
->method
, http
->uri
,
2636 conn
->clientConnection
->remote
, request
, NULL
, NULL
);
2637 assert(context
->http
->out
.offset
== 0);
2638 context
->pullData();
2639 conn
->flags
.readMore
= false;
2644 http
->request
= HTTPMSGLOCK(request
);
2645 clientSetKeepaliveFlag(http
);
2647 // Let tunneling code be fully responsible for CONNECT requests
2648 if (http
->request
->method
== METHOD_CONNECT
) {
2649 context
->mayUseConnection(true);
2650 conn
->flags
.readMore
= false;
2653 /* Do we expect a request-body? */
2654 expectBody
= chunked
|| request
->content_length
> 0;
2655 if (!context
->mayUseConnection() && expectBody
) {
2656 request
->body_pipe
= conn
->expectRequestBody(
2657 chunked
? -1 : request
->content_length
);
2659 // consume header early so that body pipe gets just the body
2660 connNoteUseOfBuffer(conn
, http
->req_sz
);
2661 notedUseOfBuffer
= true;
2663 /* Is it too large? */
2664 if (!chunked
&& // if chunked, we will check as we accumulate
2665 clientIsRequestBodyTooLargeForPolicy(request
->content_length
)) {
2666 clientStreamNode
*node
= context
->getClientReplyContext();
2667 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
2668 assert (repContext
);
2669 repContext
->setReplyToError(ERR_TOO_BIG
,
2670 HTTP_REQUEST_ENTITY_TOO_LARGE
, METHOD_NONE
, NULL
,
2671 conn
->clientConnection
->remote
, http
->request
, NULL
, NULL
);
2672 assert(context
->http
->out
.offset
== 0);
2673 context
->pullData();
2674 conn
->flags
.readMore
= false;
2678 // We may stop producing, comm_close, and/or call setReplyToError()
2679 // below, so quit on errors to avoid http->doCallouts()
2680 if (!conn
->handleRequestBodyData())
2683 if (!request
->body_pipe
->productionEnded()) {
2684 debugs(33, 5, HERE
<< "need more request body");
2685 context
->mayUseConnection(true);
2686 assert(conn
->flags
.readMore
);
2690 http
->calloutContext
= new ClientRequestContext(http
);
2695 if (!notedUseOfBuffer
)
2696 connNoteUseOfBuffer(conn
, http
->req_sz
);
2700 * Moved the TCP_RESET feature from clientReplyContext::sendMoreData
2701 * to here because calling comm_reset_close() causes http to
2702 * be freed and the above connNoteUseOfBuffer() would hit an
2703 * assertion, not to mention that we were accessing freed memory.
2705 if (request
&& request
->flags
.resetTCP() && Comm::IsConnOpen(conn
->clientConnection
)) {
2706 debugs(33, 3, HERE
<< "Sending TCP RST on " << conn
->clientConnection
);
2707 conn
->flags
.readMore
= false;
2708 comm_reset_close(conn
->clientConnection
);
2713 connStripBufferWhitespace (ConnStateData
* conn
)
2715 while (conn
->in
.notYetUsed
> 0 && xisspace(conn
->in
.buf
[0])) {
2716 memmove(conn
->in
.buf
, conn
->in
.buf
+ 1, conn
->in
.notYetUsed
- 1);
2717 --conn
->in
.notYetUsed
;
2722 connOkToAddRequest(ConnStateData
* conn
)
2724 int result
= conn
->getConcurrentRequestCount() < (Config
.onoff
.pipeline_prefetch
? 2 : 1);
2727 debugs(33, 3, HERE
<< conn
->clientConnection
<< " max concurrent requests reached");
2728 debugs(33, 5, HERE
<< conn
->clientConnection
<< " defering new request until one is done");
2735 * Attempt to parse one or more requests from the input buffer.
2736 * If a request is successfully parsed, even if the next request
2737 * is only partially parsed, it will return TRUE.
2740 ConnStateData::clientParseRequests()
2742 HttpRequestMethod method
;
2743 bool parsed_req
= false;
2744 HttpVersion http_ver
;
2746 debugs(33, 5, HERE
<< clientConnection
<< ": attempting to parse");
2748 // Loop while we have read bytes that are not needed for producing the body
2749 // On errors, bodyPipe may become nil, but readMore will be cleared
2750 while (in
.notYetUsed
> 0 && !bodyPipe
&& flags
.readMore
) {
2751 connStripBufferWhitespace(this);
2753 /* Don't try to parse if the buffer is empty */
2754 if (in
.notYetUsed
== 0)
2757 /* Limit the number of concurrent requests to 2 */
2758 if (!connOkToAddRequest(this)) {
2762 /* Should not be needed anymore */
2763 /* Terminate the string */
2764 in
.buf
[in
.notYetUsed
] = '\0';
2766 /* Begin the parsing */
2767 PROF_start(parseHttpRequest
);
2768 HttpParserInit(&parser_
, in
.buf
, in
.notYetUsed
);
2770 /* Process request */
2771 ClientSocketContext
*context
= parseHttpRequest(this, &parser_
, &method
, &http_ver
);
2772 PROF_stop(parseHttpRequest
);
2774 /* partial or incomplete request */
2776 // TODO: why parseHttpRequest can just return parseHttpRequestAbort
2777 // (which becomes context) but checkHeaderLimits cannot?
2778 checkHeaderLimits();
2782 /* status -1 or 1 */
2784 debugs(33, 5, HERE
<< clientConnection
<< ": parsed a request");
2785 AsyncCall::Pointer timeoutCall
= commCbCall(5, 4, "clientLifetimeTimeout",
2786 CommTimeoutCbPtrFun(clientLifetimeTimeout
, context
->http
));
2787 commSetConnTimeout(clientConnection
, Config
.Timeout
.lifetime
, timeoutCall
);
2789 clientProcessRequest(this, &parser_
, context
, method
, http_ver
);
2791 parsed_req
= true; // XXX: do we really need to parse everything right NOW ?
2793 if (context
->mayUseConnection()) {
2794 debugs(33, 3, HERE
<< "Not parsing new requests, as this request may need the connection");
2800 /* XXX where to 'finish' the parsing pass? */
2805 ConnStateData::clientReadRequest(const CommIoCbParams
&io
)
2807 debugs(33,5,HERE
<< io
.conn
<< " size " << io
.size
);
2811 /* Bail out quickly on COMM_ERR_CLOSING - close handlers will tidy up */
2813 if (io
.flag
== COMM_ERR_CLOSING
) {
2814 debugs(33,5, HERE
<< io
.conn
<< " closing Bailout.");
2818 assert(Comm::IsConnOpen(clientConnection
));
2819 assert(io
.conn
->fd
== clientConnection
->fd
);
2822 * Don't reset the timeout value here. The timeout value will be
2823 * set to Config.Timeout.request by httpAccept() and
2824 * clientWriteComplete(), and should apply to the request as a
2825 * whole, not individual read() calls. Plus, it breaks our
2826 * lame half-close detection
2828 if (connReadWasError(io
.flag
, io
.size
, io
.xerrno
)) {
2829 notifyAllContexts(io
.xerrno
);
2834 if (io
.flag
== COMM_OK
) {
2836 kb_incr(&(statCounter
.client_http
.kbytes_in
), io
.size
);
2838 // may comm_close or setReplyToError
2839 if (!handleReadData(io
.buf
, io
.size
))
2842 } else if (io
.size
== 0) {
2843 debugs(33, 5, HERE
<< io
.conn
<< " closed?");
2845 if (connFinishedWithConn(io
.size
)) {
2846 clientConnection
->close();
2850 /* It might be half-closed, we can't tell */
2851 fd_table
[io
.conn
->fd
].flags
.socket_eof
= 1;
2853 commMarkHalfClosed(io
.conn
->fd
);
2855 fd_note(io
.conn
->fd
, "half-closed");
2857 /* There is one more close check at the end, to detect aborted
2858 * (partial) requests. At this point we can't tell if the request
2861 /* Continue to process previously read data */
2865 /* Process next request */
2866 if (getConcurrentRequestCount() == 0)
2867 fd_note(io
.fd
, "Reading next request");
2869 if (!clientParseRequests()) {
2873 * If the client here is half closed and we failed
2874 * to parse a request, close the connection.
2875 * The above check with connFinishedWithConn() only
2876 * succeeds _if_ the buffer is empty which it won't
2877 * be if we have an incomplete request.
2878 * XXX: This duplicates ClientSocketContext::keepaliveNextRequest
2880 if (getConcurrentRequestCount() == 0 && commIsHalfClosed(io
.fd
)) {
2881 debugs(33, 5, HERE
<< io
.conn
<< ": half-closed connection, no completed request parsed, connection closing.");
2882 clientConnection
->close();
2890 clientAfterReadingRequests();
2894 * called when new request data has been read from the socket
2896 * \retval false called comm_close or setReplyToError (the caller should bail)
2897 * \retval true we did not call comm_close or setReplyToError
2900 ConnStateData::handleReadData(char *buf
, size_t size
)
2902 char *current_buf
= in
.addressToReadInto();
2904 if (buf
!= current_buf
)
2905 memmove(current_buf
, buf
, size
);
2907 in
.notYetUsed
+= size
;
2909 in
.buf
[in
.notYetUsed
] = '\0'; /* Terminate the string */
2911 // if we are reading a body, stuff data into the body pipe
2912 if (bodyPipe
!= NULL
)
2913 return handleRequestBodyData();
2918 * called when new request body data has been buffered in in.buf
2919 * may close the connection if we were closing and piped everything out
2921 * \retval false called comm_close or setReplyToError (the caller should bail)
2922 * \retval true we did not call comm_close or setReplyToError
2925 ConnStateData::handleRequestBodyData()
2927 assert(bodyPipe
!= NULL
);
2931 if (in
.bodyParser
) { // chunked encoding
2932 if (const err_type error
= handleChunkedRequestBody(putSize
)) {
2933 abortChunkedRequestBody(error
);
2936 } else { // identity encoding
2937 debugs(33,5, HERE
<< "handling plain request body for " << clientConnection
);
2938 putSize
= bodyPipe
->putMoreData(in
.buf
, in
.notYetUsed
);
2939 if (!bodyPipe
->mayNeedMoreData()) {
2940 // BodyPipe will clear us automagically when we produced everything
2946 connNoteUseOfBuffer(this, putSize
);
2949 debugs(33,5, HERE
<< "produced entire request body for " << clientConnection
);
2951 if (const char *reason
= stoppedSending()) {
2952 /* we've finished reading like good clients,
2953 * now do the close that initiateClose initiated.
2955 debugs(33, 3, HERE
<< "closing for earlier sending error: " << reason
);
2956 clientConnection
->close();
2964 /// parses available chunked encoded body bytes, checks size, returns errors
2966 ConnStateData::handleChunkedRequestBody(size_t &putSize
)
2968 debugs(33,7, HERE
<< "chunked from " << clientConnection
<< ": " << in
.notYetUsed
);
2970 try { // the parser will throw on errors
2972 if (!in
.notYetUsed
) // nothing to do (MemBuf::init requires this check)
2975 MemBuf raw
; // ChunkedCodingParser only works with MemBufs
2976 // add one because MemBuf will assert if it cannot 0-terminate
2977 raw
.init(in
.notYetUsed
, in
.notYetUsed
+1);
2978 raw
.append(in
.buf
, in
.notYetUsed
);
2980 const mb_size_t wasContentSize
= raw
.contentSize();
2981 BodyPipeCheckout
bpc(*bodyPipe
);
2982 const bool parsed
= in
.bodyParser
->parse(&raw
, &bpc
.buf
);
2984 putSize
= wasContentSize
- raw
.contentSize();
2986 // dechunk then check: the size limit applies to _dechunked_ content
2987 if (clientIsRequestBodyTooLargeForPolicy(bodyPipe
->producedSize()))
2991 finishDechunkingRequest(true);
2993 return ERR_NONE
; // nil bodyPipe implies body end for the caller
2996 // if chunk parser needs data, then the body pipe must need it too
2997 Must(!in
.bodyParser
->needsMoreData() || bodyPipe
->mayNeedMoreData());
2999 // if parser needs more space and we can consume nothing, we will stall
3000 Must(!in
.bodyParser
->needsMoreSpace() || bodyPipe
->buf().hasContent());
3001 } catch (...) { // TODO: be more specific
3002 debugs(33, 3, HERE
<< "malformed chunks" << bodyPipe
->status());
3003 return ERR_INVALID_REQ
;
3006 debugs(33, 7, HERE
<< "need more chunked data" << *bodyPipe
->status());
3010 /// quit on errors related to chunked request body handling
3012 ConnStateData::abortChunkedRequestBody(const err_type error
)
3014 finishDechunkingRequest(false);
3016 // XXX: The code below works if we fail during initial request parsing,
3017 // but if we fail when the server-side works already, the server may send
3018 // us its response too, causing various assertions. How to prevent that?
3019 #if WE_KNOW_HOW_TO_SEND_ERRORS
3020 ClientSocketContext::Pointer context
= getCurrentContext();
3021 if (context
!= NULL
&& !context
->http
->out
.offset
) { // output nothing yet
3022 clientStreamNode
*node
= context
->getClientReplyContext();
3023 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
3025 const http_status scode
= (error
== ERR_TOO_BIG
) ?
3026 HTTP_REQUEST_ENTITY_TOO_LARGE
: HTTP_BAD_REQUEST
;
3027 repContext
->setReplyToError(error
, scode
,
3028 repContext
->http
->request
->method
,
3029 repContext
->http
->uri
,
3031 repContext
->http
->request
,
3033 context
->pullData();
3035 // close or otherwise we may get stuck as nobody will notice the error?
3036 comm_reset_close(clientConnection
);
3039 debugs(33, 3, HERE
<< "aborting chunked request without error " << error
);
3040 comm_reset_close(clientConnection
);
3042 flags
.readMore
= false;
3046 ConnStateData::noteMoreBodySpaceAvailable(BodyPipe::Pointer
)
3048 if (!handleRequestBodyData())
3051 // too late to read more body
3052 if (!isOpen() || stoppedReceiving())
3059 ConnStateData::noteBodyConsumerAborted(BodyPipe::Pointer
)
3061 // request reader may get stuck waiting for space if nobody consumes body
3062 if (bodyPipe
!= NULL
)
3063 bodyPipe
->enableAutoConsumption();
3065 stopReceiving("virgin request body consumer aborted"); // closes ASAP
3068 /** general lifetime handler for HTTP requests */
3070 ConnStateData::requestTimeout(const CommTimeoutCbParams
&io
)
3072 #if THIS_CONFUSES_PERSISTENT_CONNECTION_AWARE_BROWSERS_AND_USERS
3073 debugs(33, 3, "requestTimeout: FD " << io
.fd
<< ": lifetime is expired.");
3075 if (COMMIO_FD_WRITECB(io
.fd
)->active
) {
3076 /* FIXME: If this code is reinstated, check the conn counters,
3077 * not the fd table state
3080 * Some data has been sent to the client, just close the FD
3082 clientConnection
->close();
3083 } else if (nrequests
) {
3085 * assume its a persistent connection; just close it
3087 clientConnection
->close();
3092 ClientHttpRequest
**H
;
3093 clientStreamNode
*node
;
3094 ClientHttpRequest
*http
= parseHttpRequestAbort(this, "error:Connection%20lifetime%20expired");
3095 node
= http
->client_stream
.tail
->prev
->data
;
3096 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
3097 assert (repContext
);
3098 repContext
->setReplyToError(ERR_LIFETIME_EXP
,
3099 HTTP_REQUEST_TIMEOUT
, METHOD_NONE
, "N/A", &peer
.sin_addr
,
3101 /* No requests can be outstanded */
3102 assert(chr
== NULL
);
3103 /* add to the client request queue */
3105 for (H
= &chr
; *H
; H
= &(*H
)->next
);
3108 clientStreamRead(http
->client_stream
.tail
->data
, http
, 0,
3109 HTTP_REQBUF_SZ
, context
->reqbuf
);
3112 * if we don't close() here, we still need a timeout handler!
3114 typedef CommCbMemFunT
<ConnStateData
, CommTimeoutCbParams
> TimeoutDialer
;
3115 AsyncCall::Pointer timeoutCall
= JobCallback(33, 5,
3116 TimeoutDialer
, this, ConnStateData::requestTimeout
);
3117 commSetConnTimeout(io
.conn
, 30, timeoutCall
);
3120 * Aha, but we don't want a read handler!
3122 Comm::SetSelect(io
.fd
, COMM_SELECT_READ
, NULL
, NULL
, 0);
3127 * Just close the connection to not confuse browsers
3128 * using persistent connections. Some browsers opens
3129 * an connection and then does not use it until much
3130 * later (presumeably because the request triggering
3131 * the open has already been completed on another
3134 debugs(33, 3, "requestTimeout: FD " << io
.fd
<< ": lifetime is expired.");
3140 clientLifetimeTimeout(const CommTimeoutCbParams
&io
)
3142 ClientHttpRequest
*http
= static_cast<ClientHttpRequest
*>(io
.data
);
3143 debugs(33, DBG_IMPORTANT
, "WARNING: Closing client connection due to lifetime timeout");
3144 debugs(33, DBG_IMPORTANT
, "\t" << http
->uri
);
3145 http
->al
.http
.timedout
= true;
3146 if (Comm::IsConnOpen(io
.conn
))
3151 connStateCreate(const Comm::ConnectionPointer
&client
, http_port_list
*port
)
3153 ConnStateData
*result
= new ConnStateData
;
3155 result
->clientConnection
= client
;
3156 result
->log_addr
= client
->remote
;
3157 result
->log_addr
.ApplyMask(Config
.Addrs
.client_netmask
);
3158 result
->in
.buf
= (char *)memAllocBuf(CLIENT_REQ_BUF_SZ
, &result
->in
.allocatedSize
);
3159 result
->port
= cbdataReference(port
);
3161 if (port
->disable_pmtu_discovery
!= DISABLE_PMTU_OFF
&&
3162 (result
->transparent() || port
->disable_pmtu_discovery
== DISABLE_PMTU_ALWAYS
)) {
3163 #if defined(IP_MTU_DISCOVER) && defined(IP_PMTUDISC_DONT)
3164 int i
= IP_PMTUDISC_DONT
;
3165 setsockopt(client
->fd
, SOL_IP
, IP_MTU_DISCOVER
, &i
, sizeof i
);
3167 static int reported
= 0;
3170 debugs(33, 1, "Notice: httpd_accel_no_pmtu_disc not supported on your platform");
3176 typedef CommCbMemFunT
<ConnStateData
, CommCloseCbParams
> Dialer
;
3177 AsyncCall::Pointer call
= JobCallback(33, 5, Dialer
, result
, ConnStateData::connStateClosed
);
3178 comm_add_close_handler(client
->fd
, call
);
3180 if (Config
.onoff
.log_fqdn
)
3181 fqdncache_gethostbyaddr(client
->remote
, FQDN_LOOKUP_IF_MISS
);
3184 if (Ident::TheConfig
.identLookup
) {
3185 ACLFilledChecklist
identChecklist(Ident::TheConfig
.identLookup
, NULL
, NULL
);
3186 identChecklist
.src_addr
= client
->remote
;
3187 identChecklist
.my_addr
= client
->local
;
3188 if (identChecklist
.fastCheck() == ACCESS_ALLOWED
)
3189 Ident::Start(client
, clientIdentDone
, result
);
3194 if (Eui::TheConfig
.euiLookup
) {
3195 if (client
->remote
.IsIPv4()) {
3196 result
->clientConnection
->remoteEui48
.lookup(client
->remote
);
3197 } else if (client
->remote
.IsIPv6()) {
3198 result
->clientConnection
->remoteEui64
.lookup(client
->remote
);
3203 clientdbEstablished(client
->remote
, 1);
3205 result
->flags
.readMore
= true;
3209 /** Handle a new connection on HTTP socket. */
3211 httpAccept(const CommAcceptCbParams
¶ms
)
3213 http_port_list
*s
= (http_port_list
*)params
.data
;
3215 if (params
.flag
!= COMM_OK
) {
3216 // Its possible the call was still queued when the client disconnected
3217 debugs(33, 2, "httpAccept: " << s
->listenConn
<< ": accept failure: " << xstrerr(params
.xerrno
));
3221 debugs(33, 4, HERE
<< params
.conn
<< ": accepted");
3222 fd_note(params
.conn
->fd
, "client http connect");
3224 if (s
->tcp_keepalive
.enabled
) {
3225 commSetTcpKeepalive(params
.conn
->fd
, s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3228 incoming_sockets_accepted
++;
3230 // Socket is ready, setup the connection manager to start using it
3231 ConnStateData
*connState
= connStateCreate(params
.conn
, s
);
3233 typedef CommCbMemFunT
<ConnStateData
, CommTimeoutCbParams
> TimeoutDialer
;
3234 AsyncCall::Pointer timeoutCall
= JobCallback(33, 5,
3235 TimeoutDialer
, connState
, ConnStateData::requestTimeout
);
3236 commSetConnTimeout(params
.conn
, Config
.Timeout
.read
, timeoutCall
);
3238 connState
->readSomeData();
3241 fd_table
[params
.conn
->fd
].clientInfo
= NULL
;
3243 if (Config
.onoff
.client_db
) {
3244 /* it was said several times that client write limiter does not work if client_db is disabled */
3246 ClientDelayPools
& pools(Config
.ClientDelay
.pools
);
3247 ACLFilledChecklist
ch(NULL
, NULL
, NULL
);
3249 // TODO: we check early to limit error response bandwith but we
3250 // should recheck when we can honor delay_pool_uses_indirect
3251 // TODO: we should also pass the port details for myportname here.
3252 ch
.src_addr
= params
.conn
->remote
;
3253 ch
.my_addr
= params
.conn
->local
;
3255 for (unsigned int pool
= 0; pool
< pools
.size(); pool
++) {
3257 /* pools require explicit 'allow' to assign a client into them */
3258 if (pools
[pool
].access
) {
3259 ch
.accessList
= pools
[pool
].access
;
3260 allow_t answer
= ch
.fastCheck();
3261 if (answer
== ACCESS_ALLOWED
) {
3263 /* request client information from db after we did all checks
3264 this will save hash lookup if client failed checks */
3265 ClientInfo
* cli
= clientdbGetInfo(params
.conn
->remote
);
3268 /* put client info in FDE */
3269 fd_table
[params
.conn
->fd
].clientInfo
= cli
;
3271 /* setup write limiter for this request */
3272 const double burst
= floor(0.5 +
3273 (pools
[pool
].highwatermark
* Config
.ClientDelay
.initial
)/100.0);
3274 cli
->setWriteLimiter(pools
[pool
].rate
, burst
, pools
[pool
].highwatermark
);
3277 debugs(83, 4, HERE
<< "Delay pool " << pool
<< " skipped because ACL " << answer
);
3287 /** Create SSL connection structure and update fd_table */
3289 httpsCreate(const Comm::ConnectionPointer
&conn
, SSL_CTX
*sslContext
)
3291 SSL
*ssl
= SSL_new(sslContext
);
3294 const int ssl_error
= ERR_get_error();
3295 debugs(83, DBG_IMPORTANT
, "ERROR: httpsAccept: Error allocating handle: " << ERR_error_string(ssl_error
, NULL
) );
3300 SSL_set_fd(ssl
, conn
->fd
);
3301 fd_table
[conn
->fd
].ssl
= ssl
;
3302 fd_table
[conn
->fd
].read_method
= &ssl_read_method
;
3303 fd_table
[conn
->fd
].write_method
= &ssl_write_method
;
3305 debugs(33, 5, "httpsCreate: will negotate SSL on " << conn
);
3306 fd_note(conn
->fd
, "client https start");
3311 /** negotiate an SSL connection */
3313 clientNegotiateSSL(int fd
, void *data
)
3315 ConnStateData
*conn
= (ConnStateData
*)data
;
3317 SSL
*ssl
= fd_table
[fd
].ssl
;
3320 if ((ret
= SSL_accept(ssl
)) <= 0) {
3321 int ssl_error
= SSL_get_error(ssl
, ret
);
3323 switch (ssl_error
) {
3325 case SSL_ERROR_WANT_READ
:
3326 Comm::SetSelect(fd
, COMM_SELECT_READ
, clientNegotiateSSL
, conn
, 0);
3329 case SSL_ERROR_WANT_WRITE
:
3330 Comm::SetSelect(fd
, COMM_SELECT_WRITE
, clientNegotiateSSL
, conn
, 0);
3333 case SSL_ERROR_SYSCALL
:
3336 debugs(83, 2, "clientNegotiateSSL: Error negotiating SSL connection on FD " << fd
<< ": Aborted by client");
3342 if (errno
== ECONNRESET
)
3345 debugs(83, hard
? 1 : 2, "clientNegotiateSSL: Error negotiating SSL connection on FD " <<
3346 fd
<< ": " << strerror(errno
) << " (" << errno
<< ")");
3353 case SSL_ERROR_ZERO_RETURN
:
3354 debugs(83, 1, "clientNegotiateSSL: Error negotiating SSL connection on FD " << fd
<< ": Closed by client");
3359 debugs(83, 1, "clientNegotiateSSL: Error negotiating SSL connection on FD " <<
3360 fd
<< ": " << ERR_error_string(ERR_get_error(), NULL
) <<
3361 " (" << ssl_error
<< "/" << ret
<< ")");
3369 if (SSL_session_reused(ssl
)) {
3370 debugs(83, 2, "clientNegotiateSSL: Session " << SSL_get_session(ssl
) <<
3371 " reused on FD " << fd
<< " (" << fd_table
[fd
].ipaddr
<< ":" << (int)fd_table
[fd
].remote_port
<< ")");
3373 if (do_debug(83, 4)) {
3374 /* Write out the SSL session details.. actually the call below, but
3375 * OpenSSL headers do strange typecasts confusing GCC.. */
3376 /* PEM_write_SSL_SESSION(debug_log, SSL_get_session(ssl)); */
3377 #if defined(OPENSSL_VERSION_NUMBER) && OPENSSL_VERSION_NUMBER >= 0x00908000L
3378 PEM_ASN1_write((i2d_of_void
*)i2d_SSL_SESSION
, PEM_STRING_SSL_SESSION
, debug_log
, (char *)SSL_get_session(ssl
), NULL
,NULL
,0,NULL
,NULL
);
3380 #elif (ALLOW_ALWAYS_SSL_SESSION_DETAIL == 1)
3382 /* When using gcc 3.3.x and OpenSSL 0.9.7x sometimes a compile error can occur here.
3383 * This is caused by an unpredicatble gcc behaviour on a cast of the first argument
3384 * of PEM_ASN1_write(). For this reason this code section is disabled. To enable it,
3385 * define ALLOW_ALWAYS_SSL_SESSION_DETAIL=1.
3386 * Because there are two possible usable cast, if you get an error here, try the other
3387 * commented line. */
3389 PEM_ASN1_write((int(*)())i2d_SSL_SESSION
, PEM_STRING_SSL_SESSION
, debug_log
, (char *)SSL_get_session(ssl
), NULL
,NULL
,0,NULL
,NULL
);
3390 /* PEM_ASN1_write((int(*)(...))i2d_SSL_SESSION, PEM_STRING_SSL_SESSION, debug_log, (char *)SSL_get_session(ssl), NULL,NULL,0,NULL,NULL); */
3394 debugs(83, 4, "With " OPENSSL_VERSION_TEXT
", session details are available only defining ALLOW_ALWAYS_SSL_SESSION_DETAIL=1 in the source." );
3397 /* Note: This does not automatically fflush the log file.. */
3400 debugs(83, 2, "clientNegotiateSSL: New session " <<
3401 SSL_get_session(ssl
) << " on FD " << fd
<< " (" <<
3402 fd_table
[fd
].ipaddr
<< ":" << (int)fd_table
[fd
].remote_port
<<
3406 debugs(83, 3, "clientNegotiateSSL: FD " << fd
<< " negotiated cipher " <<
3407 SSL_get_cipher(ssl
));
3409 client_cert
= SSL_get_peer_certificate(ssl
);
3411 if (client_cert
!= NULL
) {
3412 debugs(83, 3, "clientNegotiateSSL: FD " << fd
<<
3413 " client certificate: subject: " <<
3414 X509_NAME_oneline(X509_get_subject_name(client_cert
), 0, 0));
3416 debugs(83, 3, "clientNegotiateSSL: FD " << fd
<<
3417 " client certificate: issuer: " <<
3418 X509_NAME_oneline(X509_get_issuer_name(client_cert
), 0, 0));
3421 X509_free(client_cert
);
3423 debugs(83, 5, "clientNegotiateSSL: FD " << fd
<<
3424 " has no certificate.");
3427 conn
->readSomeData();
3430 /** handle a new HTTPS connection */
3432 httpsAccept(const CommAcceptCbParams
¶ms
)
3434 http_port_list
*s
= (http_port_list
*)params
.data
;
3436 if (params
.flag
!= COMM_OK
) {
3437 // Its possible the call was still queued when the client disconnected
3438 debugs(33, 2, "httpsAccept: " << s
->listenConn
<< ": accept failure: " << xstrerr(params
.xerrno
));
3442 SSL_CTX
*sslContext
= s
->staticSslContext
.get();
3444 if (!(ssl
= httpsCreate(params
.conn
, sslContext
)))
3447 debugs(33, 4, HERE
<< params
.conn
<< " accepted, starting SSL negotiation.");
3448 fd_note(params
.conn
->fd
, "client https connect");
3450 if (s
->tcp_keepalive
.enabled
) {
3451 commSetTcpKeepalive(params
.conn
->fd
, s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
3454 incoming_sockets_accepted
++;
3456 // Socket is ready, setup the connection manager to start using it
3457 ConnStateData
*connState
= connStateCreate(params
.conn
, s
);
3459 typedef CommCbMemFunT
<ConnStateData
, CommTimeoutCbParams
> TimeoutDialer
;
3460 AsyncCall::Pointer timeoutCall
= JobCallback(33, 5,
3461 TimeoutDialer
, connState
, ConnStateData::requestTimeout
);
3462 commSetConnTimeout(params
.conn
, Config
.Timeout
.request
, timeoutCall
);
3464 Comm::SetSelect(params
.conn
->fd
, COMM_SELECT_READ
, clientNegotiateSSL
, connState
, 0);
3468 ConnStateData::sslCrtdHandleReplyWrapper(void *data
, char *reply
)
3470 ConnStateData
* state_data
= (ConnStateData
*)(data
);
3471 state_data
->sslCrtdHandleReply(reply
);
3475 ConnStateData::sslCrtdHandleReply(const char * reply
)
3478 debugs(1, 1, HERE
<< "\"ssl_crtd\" helper return <NULL> reply");
3480 Ssl::CrtdMessage reply_message
;
3481 if (reply_message
.parse(reply
, strlen(reply
)) != Ssl::CrtdMessage::OK
) {
3482 debugs(33, 5, HERE
<< "Reply from ssl_crtd for " << sslHostName
<< " is incorrect");
3484 if (reply_message
.getCode() != "OK") {
3485 debugs(33, 5, HERE
<< "Certificate for " << sslHostName
<< " cannot be generated. ssl_crtd response: " << reply_message
.getBody());
3487 debugs(33, 5, HERE
<< "Certificate for " << sslHostName
<< " was successfully recieved from ssl_crtd");
3488 SSL_CTX
*ctx
= Ssl::generateSslContextUsingPkeyAndCertFromMemory(reply_message
.getBody().c_str());
3489 getSslContextDone(ctx
, true);
3494 getSslContextDone(NULL
);
3498 ConnStateData::getSslContextStart()
3500 char const * host
= sslHostName
.termedBuf();
3501 if (port
->generateHostCertificates
&& host
&& strcmp(host
, "") != 0) {
3502 debugs(33, 5, HERE
<< "Finding SSL certificate for " << host
<< " in cache");
3503 Ssl::LocalContextStorage
& ssl_ctx_cache(Ssl::TheGlobalContextStorage
.getLocalStorage(port
->s
));
3504 SSL_CTX
* dynCtx
= ssl_ctx_cache
.find(host
);
3506 debugs(33, 5, HERE
<< "SSL certificate for " << host
<< " have found in cache");
3507 if (Ssl::verifySslCertificateDate(dynCtx
)) {
3508 debugs(33, 5, HERE
<< "Cached SSL certificate for " << host
<< " is valid");
3509 return getSslContextDone(dynCtx
);
3511 debugs(33, 5, HERE
<< "Cached SSL certificate for " << host
<< " is out of date. Delete this certificate from cache");
3512 ssl_ctx_cache
.remove(host
);
3515 debugs(33, 5, HERE
<< "SSL certificate for " << host
<< " haven't found in cache");
3519 debugs(33, 5, HERE
<< "Generating SSL certificate for " << host
<< " using ssl_crtd.");
3520 Ssl::CrtdMessage request_message
;
3521 request_message
.setCode(Ssl::CrtdMessage::code_new_certificate
);
3522 Ssl::CrtdMessage::BodyParams map
;
3523 map
.insert(std::make_pair(Ssl::CrtdMessage::param_host
, host
));
3524 std::string bufferToWrite
;
3525 Ssl::writeCertAndPrivateKeyToMemory(port
->signingCert
, port
->signPkey
, bufferToWrite
);
3526 request_message
.composeBody(map
, bufferToWrite
);
3527 Ssl::Helper::GetInstance()->sslSubmit(request_message
, sslCrtdHandleReplyWrapper
, this);
3530 debugs(33, 5, HERE
<< "Generating SSL certificate for " << host
);
3531 dynCtx
= Ssl::generateSslContext(host
, port
->signingCert
, port
->signPkey
);
3532 return getSslContextDone(dynCtx
, true);
3533 #endif //USE_SSL_CRTD
3535 return getSslContextDone(NULL
);
3539 ConnStateData::getSslContextDone(SSL_CTX
* sslContext
, bool isNew
)
3541 // Try to add generated ssl context to storage.
3542 if (port
->generateHostCertificates
&& isNew
) {
3544 Ssl::addChainToSslContext(sslContext
, port
->certsToChain
.get());
3546 Ssl::LocalContextStorage
& ssl_ctx_cache(Ssl::TheGlobalContextStorage
.getLocalStorage(port
->s
));
3547 if (sslContext
&& sslHostName
!= "") {
3548 if (!ssl_ctx_cache
.add(sslHostName
.termedBuf(), sslContext
)) {
3549 // If it is not in storage delete after using. Else storage deleted it.
3550 fd_table
[clientConnection
->fd
].dynamicSslContext
= sslContext
;
3553 debugs(33, 2, HERE
<< "Failed to generate SSL cert for " << sslHostName
);
3557 // If generated ssl context = NULL, try to use static ssl context.
3559 if (!port
->staticSslContext
) {
3560 debugs(83, 1, "Closing SSL " << clientConnection
->remote
<< " as lacking SSL context");
3561 clientConnection
->close();
3564 debugs(33, 5, HERE
<< "Using static ssl context.");
3565 sslContext
= port
->staticSslContext
.get();
3570 if (!(ssl
= httpsCreate(clientConnection
, sslContext
)))
3573 // commSetConnTimeout() was called for this request before we switched.
3575 // Disable the client read handler until peer selection is complete
3576 Comm::SetSelect(clientConnection
->fd
, COMM_SELECT_READ
, NULL
, NULL
, 0);
3577 Comm::SetSelect(clientConnection
->fd
, COMM_SELECT_READ
, clientNegotiateSSL
, this, 0);
3578 switchedToHttps_
= true;
3583 ConnStateData::switchToHttps(const char *host
)
3585 assert(!switchedToHttps_
);
3589 //HTTPMSGLOCK(currentobject->http->request);
3590 assert(areAllContextsForThisConnection());
3592 //currentobject->connIsFinished();
3594 // We are going to read new request
3595 flags
.readMore
= true;
3596 debugs(33, 5, HERE
<< "converting " << clientConnection
<< " to SSL");
3598 return getSslContextStart();
3601 #endif /* USE_SSL */
3603 /// check FD after clientHttp[s]ConnectionOpened, adjust HttpSockets as needed
3605 OpenedHttpSocket(const Comm::ConnectionPointer
&c
, const Ipc::FdNoteId portType
)
3607 if (!Comm::IsConnOpen(c
)) {
3608 Must(NHttpSockets
> 0); // we tried to open some
3609 --NHttpSockets
; // there will be fewer sockets than planned
3610 Must(HttpSockets
[NHttpSockets
] < 0); // no extra fds received
3612 if (!NHttpSockets
) // we could not open any listen sockets at all
3613 fatalf("Unable to open %s",FdNote(portType
));
3620 /// find any unused HttpSockets[] slot and store fd there or return false
3622 AddOpenedHttpSocket(const Comm::ConnectionPointer
&conn
)
3625 for (int i
= 0; i
< NHttpSockets
&& !found
; i
++) {
3626 if ((found
= HttpSockets
[i
] < 0))
3627 HttpSockets
[i
] = conn
->fd
;
3633 clientHttpConnectionsOpen(void)
3635 http_port_list
*s
= NULL
;
3637 for (s
= Config
.Sockaddr
.http
; s
; s
= s
->next
) {
3638 if (MAXHTTPPORTS
== NHttpSockets
) {
3639 debugs(1, 1, "WARNING: You have too many 'http_port' lines.");
3640 debugs(1, 1, " The limit is " << MAXHTTPPORTS
);
3645 if (s
->sslBump
&& !Config
.accessList
.ssl_bump
) {
3646 debugs(33, DBG_IMPORTANT
, "WARNING: No ssl_bump configured. Disabling ssl-bump on " << s
->protocol
<< "_port " << s
->s
);
3650 if (s
->sslBump
&& !s
->staticSslContext
&& !s
->generateHostCertificates
) {
3651 debugs(1, DBG_IMPORTANT
, "Will not bump SSL at http_port " << s
->s
<< " due to SSL initialization failure.");
3655 // Create ssl_ctx cache for this port.
3656 Ssl::TheGlobalContextStorage
.addLocalStorage(s
->s
, s
->dynamicCertMemCacheSize
== std::numeric_limits
<size_t>::max() ? 4194304 : s
->dynamicCertMemCacheSize
);
3660 // Fill out a Comm::Connection which IPC will open as a listener for us
3661 // then pass back when active so we can start a TcpAcceptor subscription.
3662 s
->listenConn
= new Comm::Connection
;
3663 s
->listenConn
->local
= s
->s
;
3664 s
->listenConn
->flags
= COMM_NONBLOCKING
| (s
->spoof_client_ip
? COMM_TRANSPARENT
: 0) | (s
->intercepted
? COMM_INTERCEPTION
: 0);
3666 // setup the subscriptions such that new connections accepted by listenConn are handled by HTTP
3667 typedef CommCbFunPtrCallT
<CommAcceptCbPtrFun
> AcceptCall
;
3668 RefCount
<AcceptCall
> subCall
= commCbCall(5, 5, "httpAccept", CommAcceptCbPtrFun(httpAccept
, s
));
3669 Subscription::Pointer sub
= new CallSubscription
<AcceptCall
>(subCall
);
3671 AsyncCall::Pointer listenCall
= asyncCall(33,2, "clientListenerConnectionOpened",
3672 ListeningStartedDialer(&clientListenerConnectionOpened
, s
, Ipc::fdnHttpSocket
, sub
));
3673 Ipc::StartListening(SOCK_STREAM
, IPPROTO_TCP
, s
->listenConn
, Ipc::fdnHttpSocket
, listenCall
);
3675 HttpSockets
[NHttpSockets
++] = -1; // set in clientListenerConnectionOpened
3681 clientHttpsConnectionsOpen(void)
3685 for (s
= Config
.Sockaddr
.https
; s
; s
= s
->next
) {
3686 if (MAXHTTPPORTS
== NHttpSockets
) {
3687 debugs(1, 1, "Ignoring 'https_port' lines exceeding the limit.");
3688 debugs(1, 1, "The limit is " << MAXHTTPPORTS
<< " HTTPS ports.");
3692 if (!s
->staticSslContext
) {
3693 debugs(1, 1, "Ignoring https_port " << s
->s
<<
3694 " due to SSL initialization failure.");
3698 // Fill out a Comm::Connection which IPC will open as a listener for us
3699 s
->listenConn
= new Comm::Connection
;
3700 s
->listenConn
->local
= s
->s
;
3701 s
->listenConn
->flags
= COMM_NONBLOCKING
| (s
->spoof_client_ip
? COMM_TRANSPARENT
: 0) |
3702 (s
->intercepted
? COMM_INTERCEPTION
: 0);
3704 // setup the subscriptions such that new connections accepted by listenConn are handled by HTTPS
3705 typedef CommCbFunPtrCallT
<CommAcceptCbPtrFun
> AcceptCall
;
3706 RefCount
<AcceptCall
> subCall
= commCbCall(5, 5, "httpsAccept", CommAcceptCbPtrFun(httpsAccept
, s
));
3707 Subscription::Pointer sub
= new CallSubscription
<AcceptCall
>(subCall
);
3709 AsyncCall::Pointer listenCall
= asyncCall(33, 2, "clientListenerConnectionOpened",
3710 ListeningStartedDialer(&clientListenerConnectionOpened
,
3711 s
, Ipc::fdnHttpsSocket
, sub
));
3712 Ipc::StartListening(SOCK_STREAM
, IPPROTO_TCP
, s
->listenConn
, Ipc::fdnHttpsSocket
, listenCall
);
3713 HttpSockets
[NHttpSockets
++] = -1;
3718 /// process clientHttpConnectionsOpen result
3720 clientListenerConnectionOpened(http_port_list
*s
, const Ipc::FdNoteId portTypeNote
, const Subscription::Pointer
&sub
)
3722 if (!OpenedHttpSocket(s
->listenConn
, portTypeNote
))
3726 Must(Comm::IsConnOpen(s
->listenConn
));
3728 // TCP: setup a job to handle accept() with subscribed handler
3729 AsyncJob::Start(new Comm::TcpAcceptor(s
->listenConn
, FdNote(portTypeNote
), sub
));
3731 debugs(1, 1, "Accepting " <<
3732 (s
->intercepted
? "NAT intercepted " : "") <<
3733 (s
->spoof_client_ip
? "TPROXY spoofing " : "") <<
3734 (s
->sslBump
? "SSL bumped " : "") <<
3735 (s
->accel
? "reverse-proxy " : "")
3736 << FdNote(portTypeNote
) << " connections at "
3739 Must(AddOpenedHttpSocket(s
->listenConn
)); // otherwise, we have received a fd we did not ask for
3743 clientOpenListenSockets(void)
3745 clientHttpConnectionsOpen();
3747 clientHttpsConnectionsOpen();
3750 if (NHttpSockets
< 1)
3751 fatal("No HTTP or HTTPS ports configured");
3755 clientHttpConnectionsClose(void)
3757 for (http_port_list
*s
= Config
.Sockaddr
.http
; s
; s
= s
->next
) {
3758 if (s
->listenConn
!= NULL
) {
3759 debugs(1, 1, "Closing HTTP port " << s
->listenConn
->local
);
3760 s
->listenConn
->close();
3761 s
->listenConn
= NULL
;
3766 for (http_port_list
*s
= Config
.Sockaddr
.https
; s
; s
= s
->next
) {
3767 if (s
->listenConn
!= NULL
) {
3768 debugs(1, 1, "Closing HTTPS port " << s
->listenConn
->local
);
3769 s
->listenConn
->close();
3770 s
->listenConn
= NULL
;
3775 // TODO see if we can drop HttpSockets array entirely */
3776 for (int i
= 0; i
< NHttpSockets
; i
++) {
3777 HttpSockets
[i
] = -1;
3784 varyEvaluateMatch(StoreEntry
* entry
, HttpRequest
* request
)
3786 const char *vary
= request
->vary_headers
;
3787 int has_vary
= entry
->getReply()->header
.has(HDR_VARY
);
3788 #if X_ACCELERATOR_VARY
3791 entry
->getReply()->header
.has(HDR_X_ACCELERATOR_VARY
);
3794 if (!has_vary
|| !entry
->mem_obj
->vary_headers
) {
3796 /* Oops... something odd is going on here.. */
3797 debugs(33, 1, "varyEvaluateMatch: Oops. Not a Vary object on second attempt, '" <<
3798 entry
->mem_obj
->url
<< "' '" << vary
<< "'");
3799 safe_free(request
->vary_headers
);
3804 /* This is not a varying object */
3808 /* virtual "vary" object found. Calculate the vary key and
3809 * continue the search
3811 vary
= httpMakeVaryMark(request
, entry
->getReply());
3814 request
->vary_headers
= xstrdup(vary
);
3817 /* Ouch.. we cannot handle this kind of variance */
3818 /* XXX This cannot really happen, but just to be complete */
3823 vary
= httpMakeVaryMark(request
, entry
->getReply());
3826 request
->vary_headers
= xstrdup(vary
);
3830 /* Ouch.. we cannot handle this kind of variance */
3831 /* XXX This cannot really happen, but just to be complete */
3833 } else if (strcmp(vary
, entry
->mem_obj
->vary_headers
) == 0) {
3836 /* Oops.. we have already been here and still haven't
3837 * found the requested variant. Bail out
3839 debugs(33, 1, "varyEvaluateMatch: Oops. Not a Vary match on second attempt, '" <<
3840 entry
->mem_obj
->url
<< "' '" << vary
<< "'");
3846 ACLFilledChecklist
*
3847 clientAclChecklistCreate(const acl_access
* acl
, ClientHttpRequest
* http
)
3849 ConnStateData
* conn
= http
->getConn();
3850 ACLFilledChecklist
*ch
= new ACLFilledChecklist(acl
, http
->request
,
3851 cbdataReferenceValid(conn
) && conn
!= NULL
&& conn
->clientConnection
!= NULL
? conn
->clientConnection
->rfc931
: dash_str
);
3854 * hack for ident ACL. It needs to get full addresses, and a place to store
3855 * the ident result on persistent connections...
3857 /* connection oriented auth also needs these two lines for it's operation. */
3859 * Internal requests do not have a connection reference, because: A) their
3860 * byte count may be transformed before being applied to an outbound
3861 * connection B) they are internal - any limiting on them should be done on
3866 ch
->conn(conn
); /* unreferenced in FilledCheckList.cc */
3871 CBDATA_CLASS_INIT(ConnStateData
);
3873 ConnStateData::ConnStateData() :
3874 AsyncJob("ConnStateData"),
3875 switchedToHttps_(false),
3876 stoppedSending_(NULL
),
3877 stoppedReceiving_(NULL
)
3879 pinning
.pinned
= false;
3880 pinning
.auth
= false;
3884 ConnStateData::transparent() const
3886 return clientConnection
!= NULL
&& (clientConnection
->flags
& (COMM_TRANSPARENT
|COMM_INTERCEPTION
));
3890 ConnStateData::reading() const
3892 return reader
!= NULL
;
3896 ConnStateData::stopReading()
3899 comm_read_cancel(clientConnection
->fd
, reader
);
3906 ConnStateData::expectRequestBody(int64_t size
)
3908 bodyPipe
= new BodyPipe(this);
3910 bodyPipe
->setBodySize(size
);
3912 startDechunkingRequest();
3917 ConnStateData::mayNeedToReadMoreBody() const
3920 return 0; // request without a body or read/produced all body bytes
3922 if (!bodyPipe
->bodySizeKnown())
3923 return -1; // probably need to read more, but we cannot be sure
3925 const int64_t needToProduce
= bodyPipe
->unproducedSize();
3926 const int64_t haveAvailable
= static_cast<int64_t>(in
.notYetUsed
);
3928 if (needToProduce
<= haveAvailable
)
3929 return 0; // we have read what we need (but are waiting for pipe space)
3931 return needToProduce
- haveAvailable
;
3935 ConnStateData::stopReceiving(const char *error
)
3937 debugs(33, 4, HERE
<< "receiving error (" << clientConnection
<< "): " << error
<<
3938 "; old sending error: " <<
3939 (stoppedSending() ? stoppedSending_
: "none"));
3941 if (const char *oldError
= stoppedReceiving()) {
3942 debugs(33, 3, HERE
<< "already stopped receiving: " << oldError
);
3943 return; // nothing has changed as far as this connection is concerned
3946 stoppedReceiving_
= error
;
3948 if (const char *sendError
= stoppedSending()) {
3949 debugs(33, 3, HERE
<< "closing because also stopped sending: " << sendError
);
3950 clientConnection
->close();
3955 ConnStateData::expectNoForwarding()
3957 if (bodyPipe
!= NULL
) {
3958 debugs(33, 4, HERE
<< "no consumer for virgin body " << bodyPipe
->status());
3959 bodyPipe
->expectNoConsumption();
3963 /// initialize dechunking state
3965 ConnStateData::startDechunkingRequest()
3967 Must(bodyPipe
!= NULL
);
3968 debugs(33, 5, HERE
<< "start dechunking" << bodyPipe
->status());
3969 assert(!in
.bodyParser
);
3970 in
.bodyParser
= new ChunkedCodingParser
;
3973 /// put parsed content into input buffer and clean up
3975 ConnStateData::finishDechunkingRequest(bool withSuccess
)
3977 debugs(33, 5, HERE
<< "finish dechunking: " << withSuccess
);
3979 if (bodyPipe
!= NULL
) {
3980 debugs(33, 7, HERE
<< "dechunked tail: " << bodyPipe
->status());
3981 BodyPipe::Pointer myPipe
= bodyPipe
;
3982 stopProducingFor(bodyPipe
, withSuccess
); // sets bodyPipe->bodySize()
3983 Must(!bodyPipe
); // we rely on it being nil after we are done with body
3985 Must(myPipe
->bodySizeKnown());
3986 ClientSocketContext::Pointer context
= getCurrentContext();
3987 if (context
!= NULL
&& context
->http
&& context
->http
->request
)
3988 context
->http
->request
->setContentLength(myPipe
->bodySize());
3992 delete in
.bodyParser
;
3993 in
.bodyParser
= NULL
;
3997 ConnStateData::In::addressToReadInto() const
3999 return buf
+ notYetUsed
;
4002 ConnStateData::In::In() : bodyParser(NULL
),
4003 buf (NULL
), notYetUsed (0), allocatedSize (0)
4006 ConnStateData::In::~In()
4009 memFreeBuf(allocatedSize
, buf
);
4010 delete bodyParser
; // TODO: pool
4014 ConnStateData::sendControlMsg(HttpControlMsg msg
)
4017 debugs(33, 3, HERE
<< "ignoring 1xx due to earlier closure");
4021 ClientSocketContext::Pointer context
= getCurrentContext();
4022 if (context
!= NULL
) {
4023 context
->writeControlMsg(msg
); // will call msg.cbSuccess
4027 debugs(33, 3, HERE
<< " closing due to missing context for 1xx");
4028 clientConnection
->close();
4031 /* This is a comm call normally scheduled by comm_close() */
4033 ConnStateData::clientPinnedConnectionClosed(const CommCloseCbParams
&io
)
4039 ConnStateData::pinConnection(const Comm::ConnectionPointer
&pinServer
, HttpRequest
*request
, struct peer
*aPeer
, bool auth
)
4041 char desc
[FD_DESC_SZ
];
4043 if (Comm::IsConnOpen(pinning
.serverConnection
)) {
4044 if (pinning
.serverConnection
->fd
== pinServer
->fd
)
4047 unpinConnection(); // clears fields ready for re-use. Prevent close() scheduling our close handler.
4048 pinning
.serverConnection
->close();
4050 unpinConnection(); // clears fields ready for re-use.
4052 pinning
.serverConnection
= pinServer
;
4053 pinning
.host
= xstrdup(request
->GetHost());
4054 pinning
.port
= request
->port
;
4055 pinning
.pinned
= true;
4057 pinning
.peer
= cbdataReference(aPeer
);
4058 pinning
.auth
= auth
;
4059 char stmp
[MAX_IPSTRLEN
];
4060 snprintf(desc
, FD_DESC_SZ
, "%s pinned connection for %s (%d)",
4061 (auth
|| !aPeer
) ? request
->GetHost() : aPeer
->name
, clientConnection
->remote
.ToURL(stmp
,MAX_IPSTRLEN
), clientConnection
->fd
);
4062 fd_note(pinning
.serverConnection
->fd
, desc
);
4064 typedef CommCbMemFunT
<ConnStateData
, CommCloseCbParams
> Dialer
;
4065 pinning
.closeHandler
= JobCallback(33, 5,
4066 Dialer
, this, ConnStateData::clientPinnedConnectionClosed
);
4067 comm_add_close_handler(pinning
.serverConnection
->fd
, pinning
.closeHandler
);
4070 const Comm::ConnectionPointer
4071 ConnStateData::validatePinnedConnection(HttpRequest
*request
, const struct peer
*aPeer
)
4074 if (!Comm::IsConnOpen(pinning
.serverConnection
))
4076 if (pinning
.auth
&& request
&& strcasecmp(pinning
.host
, request
->GetHost()) != 0) {
4079 if (request
&& pinning
.port
!= request
->port
) {
4082 if (pinning
.peer
&& !cbdataReferenceValid(pinning
.peer
)) {
4085 if (aPeer
!= pinning
.peer
) {
4090 /* The pinning info is not safe, remove any pinning info */
4094 return pinning
.serverConnection
;
4098 ConnStateData::unpinConnection()
4101 cbdataReferenceDone(pinning
.peer
);
4103 if (pinning
.closeHandler
!= NULL
) {
4104 comm_remove_close_handler(pinning
.serverConnection
->fd
, pinning
.closeHandler
);
4105 pinning
.closeHandler
= NULL
;
4107 /// also close the server side socket, we should not use it for any future requests...
4108 pinning
.serverConnection
->close();
4109 safe_free(pinning
.host
);
4111 /* NOTE: pinning.pinned should be kept. This combined with fd == -1 at the end of a request indicates that the host
4112 * connection has gone away */