Http1Server.cc
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 /* DEBUG: section 33 Client-side Routines */
10 
11 #include "squid.h"
12 #include "acl/FilledChecklist.h"
13 #include "client_side.h"
14 #include "client_side_reply.h"
15 #include "client_side_request.h"
16 #include "comm/Write.h"
17 #include "http/one/RequestParser.h"
18 #include "http/Stream.h"
19 #include "HttpHeaderTools.h"
20 #include "profiler/Profiler.h"
21 #include "servers/Http1Server.h"
22 #include "SquidConfig.h"
23 #include "Store.h"
24 
26 
27 Http::One::Server::Server(const MasterXaction::Pointer &xact, bool beHttpsServer):
28  AsyncJob("Http1::Server"),
29  ConnStateData(xact),
30  isHttpsServer(beHttpsServer)
31 {
32 }
33 
34 time_t
36 {
38 }
39 
40 void
42 {
44 
45  // XXX: Until we create an HttpsServer class, use this hack to allow old
46  // client_side.cc code to manipulate ConnStateData object directly
47  if (isHttpsServer) {
48  postHttpsAccept();
49  return;
50  }
51 
52  typedef CommCbMemFunT<Server, CommTimeoutCbParams> TimeoutDialer;
53  AsyncCall::Pointer timeoutCall = JobCallback(33, 5,
54  TimeoutDialer, this, Http1::Server::requestTimeout);
55  commSetConnTimeout(clientConnection, Config.Timeout.request_start_timeout, timeoutCall);
56  readSomeData();
57 }
58 
59 void
61 {
62  if (!handleRequestBodyData())
63  return;
64 
65  // too late to read more body
66  if (!isOpen() || stoppedReceiving())
67  return;
68 
69  readSomeData();
70 }
71 
74 {
75  PROF_start(HttpServer_parseOneRequest);
76 
77  // parser is incremental. Generate new parser state if we,
78  // a) do not have one already
79  // b) have completed the previous request parsing already
80  if (!parser_ || !parser_->needsMoreData())
81  parser_ = new Http1::RequestParser(mayTunnelUnsupportedProto());
82 
83  /* Process request */
84  Http::Stream *context = parseHttpRequest(this, parser_);
85 
86  PROF_stop(HttpServer_parseOneRequest);
87  return context;
88 }
89 
92 
93 bool
95 {
97  ClientHttpRequest *http = context->http;
98  if (context->flags.parsed_ok == 0) {
99  debugs(33, 2, "Invalid Request");
100  // determine which error page templates to use for specific parsing errors
101  err_type errPage = ERR_INVALID_REQ;
102  switch (parser_->parseStatusCode) {
104  // fall through to next case
105  case Http::scUriTooLong:
106  errPage = ERR_TOO_BIG;
107  break;
109  errPage = ERR_UNSUP_REQ;
110  break;
112  errPage = ERR_UNSUP_HTTPVERSION;
113  break;
114  default:
115  if (parser_->method() == METHOD_NONE || parser_->requestUri().length() == 0)
116  // no method or url parsed, probably is wrong protocol
117  errPage = ERR_PROTOCOL_UNKNOWN;
118  // else use default ERR_INVALID_REQ set above.
119  break;
120  }
121  // setReplyToError() requires log_uri
122  // must be already initialized via ConnStateData::abortRequestParsing()
123  assert(http->log_uri);
124 
125  const char * requestErrorBytes = inBuf.c_str();
126  if (!clientTunnelOnError(this, context, request, parser_->method(), errPage)) {
127  setReplyError(context, request, parser_->method(), errPage, parser_->parseStatusCode, requestErrorBytes);
128  // HttpRequest object not build yet, there is no reason to call
129  // clientProcessRequestFinished method
130  }
131 
132  return false;
133  }
134 
135  // TODO: move URL parse into Http Parser and INVALID_URL into the above parse error handling
137  mx->tcpClient = clientConnection;
138  if ((request = HttpRequest::FromUrl(http->uri, mx, parser_->method())) == NULL) {
139  debugs(33, 5, "Invalid URL: " << http->uri);
140  // setReplyToError() requires log_uri
141  http->setLogUriToRawUri(http->uri, parser_->method());
142 
143  const char * requestErrorBytes = inBuf.c_str();
144  if (!clientTunnelOnError(this, context, request, parser_->method(), ERR_INVALID_URL)) {
145  setReplyError(context, request, parser_->method(), ERR_INVALID_URL, Http::scBadRequest, requestErrorBytes);
146  // HttpRequest object not build yet, there is no reason to call
147  // clientProcessRequestFinished method
148  }
149  return false;
150  }
151 
152  /* RFC 2616 section 10.5.6 : handle unsupported HTTP major versions cleanly. */
153  /* We currently only support 0.9, 1.0, 1.1 properly */
154  /* TODO: move HTTP-specific processing into servers/HttpServer and such */
155  if ( (parser_->messageProtocol().major == 0 && parser_->messageProtocol().minor != 9) ||
156  (parser_->messageProtocol().major > 1) ) {
157 
158  debugs(33, 5, "Unsupported HTTP version discovered. :\n" << parser_->messageProtocol());
159  // setReplyToError() requires log_uri
160  http->setLogUriToRawUri(http->uri, parser_->method());
161 
162  const char * requestErrorBytes = NULL; //HttpParserHdrBuf(parser_);
163  if (!clientTunnelOnError(this, context, request, parser_->method(), ERR_UNSUP_HTTPVERSION)) {
164  setReplyError(context, request, parser_->method(), ERR_UNSUP_HTTPVERSION, Http::scHttpVersionNotSupported, requestErrorBytes);
165  clientProcessRequestFinished(this, request);
166  }
167  return false;
168  }
169 
170  /* compile headers */
171  if (parser_->messageProtocol().major >= 1 && !request->parseHeader(*parser_.getRaw())) {
172  debugs(33, 5, "Failed to parse request headers:\n" << parser_->mimeHeader());
173  // setReplyToError() requires log_uri
174  http->setLogUriToRawUri(http->uri, parser_->method());
175  const char * requestErrorBytes = NULL; //HttpParserHdrBuf(parser_);
176  if (!clientTunnelOnError(this, context, request, parser_->method(), ERR_INVALID_REQ)) {
177  setReplyError(context, request, parser_->method(), ERR_INVALID_REQ, Http::scBadRequest, requestErrorBytes);
178  clientProcessRequestFinished(this, request);
179  }
180  return false;
181  }
182 
183  // when absolute-URI is provided Host header should be ignored. However
184  // some code still uses Host directly so normalize it using the previously
185  // sanitized URL authority value.
186  // For now preserve the case where Host is completely absent. That matters.
187  if (const auto x = request->header.delById(Http::HOST)) {
188  debugs(33, 5, "normalize " << x << " Host header using " << request->url.authority());
189  SBuf tmp(request->url.authority());
190  request->header.putStr(Http::HOST, tmp.c_str());
191  }
192 
193  // TODO: We fill request notes here until we find a way to verify whether
194  // no ACL checking is performed before ClientHttpRequest::doCallouts().
195  if (hasNotes()) {
196  assert(!request->hasNotes());
197  request->notes()->append(notes().getRaw());
198  }
199 
200  http->initRequest(request.getRaw());
201 
202  return true;
203 }
204 
205 void
206 Http::One::Server::setReplyError(Http::StreamPointer &context, HttpRequest::Pointer &request, const HttpRequestMethod& method, err_type requestError, Http::StatusCode errStatusCode, const char *requestErrorBytes)
207 {
208  quitAfterError(request.getRaw());
209  if (!context->connRegistered()) {
210  debugs(33, 2, "Client stream deregister it self, nothing to do");
211  clientConnection->close();
212  return;
213  }
214  clientStreamNode *node = context->getClientReplyContext();
215  clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
216  assert (repContext);
217 
218  repContext->setReplyToError(requestError, errStatusCode, method, context->http->uri, clientConnection->remote, nullptr, requestErrorBytes, nullptr);
219 
220  assert(context->http->out.offset == 0);
221  context->pullData();
222 }
223 
224 void
226 {
227  debugs(33, 5, "Body Continuation written");
228  clientProcessRequest(this, parser_, context.getRaw());
229 }
230 
231 void
233 {
234  if (!buildHttpRequest(context))
235  return;
236 
237  ClientHttpRequest *http = context->http;
239 
240  if (request->header.has(Http::HdrType::EXPECT)) {
241  const String expect = request->header.getList(Http::HdrType::EXPECT);
242  const bool supportedExpect = (expect.caseCmp("100-continue") == 0);
243  if (!supportedExpect) {
244  clientStreamNode *node = context->getClientReplyContext();
245  quitAfterError(request.getRaw());
246  // setReplyToError() requires log_uri
247  assert(http->log_uri);
248  clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
249  assert (repContext);
251  clientConnection->remote, request.getRaw(), NULL, NULL);
252  assert(context->http->out.offset == 0);
253  context->pullData();
254  clientProcessRequestFinished(this, request);
255  return;
256  }
257 
259  ACLFilledChecklist bodyContinuationCheck(Config.accessList.forceRequestBodyContinuation, request.getRaw(), NULL);
260  bodyContinuationCheck.al = http->al;
261  bodyContinuationCheck.syncAle(request.getRaw(), http->log_uri);
262  if (bodyContinuationCheck.fastCheck().allowed()) {
263  debugs(33, 5, "Body Continuation forced");
264  request->forcedBodyContinuation = true;
265  //sendControlMsg
266  HttpReply::Pointer rep = new HttpReply;
268 
270  const AsyncCall::Pointer cb = asyncCall(11, 3, "Http1::Server::proceedAfterBodyContinuation", CbDialer(this, &Http1::Server::proceedAfterBodyContinuation, Http::StreamPointer(context)));
271  sendControlMsg(HttpControlMsg(rep, cb));
272  return;
273  }
274  }
275  }
276  clientProcessRequest(this, parser_, context.getRaw());
277 }
278 
279 void
281 {
283  stopReceiving("virgin request body consumer aborted"); // closes ASAP
284 }
285 
286 void
288 {
289  // the caller guarantees that we are dealing with the current context only
290  Http::StreamPointer context = pipeline.front();
291  Must(context != nullptr);
292  const ClientHttpRequest *http = context->http;
293  Must(http != NULL);
294 
295  // After sending Transfer-Encoding: chunked (at least), always send
296  // the last-chunk if there was no error, ignoring responseFinishedOrFailed.
297  const bool mustSendLastChunk = http->request->flags.chunkedReply &&
298  !http->request->flags.streamError &&
300  !context->startOfOutput();
301  const bool responseFinishedOrFailed = !rep &&
302  !receivedData.data &&
303  !receivedData.length;
304  if (responseFinishedOrFailed && !mustSendLastChunk) {
305  context->writeComplete(0);
306  return;
307  }
308 
309  if (!context->startOfOutput()) {
310  context->sendBody(receivedData);
311  return;
312  }
313 
314  assert(rep);
315  http->al->reply = rep;
316  HTTPMSGLOCK(http->al->reply);
317  context->sendStartOfMessage(rep, receivedData);
318 }
319 
320 bool
322 {
323  Http::StreamPointer context = pipeline.front();
324  Must(context != nullptr);
325 
326  // Ignore this late control message if we have started sending a
327  // reply to the user already (e.g., after an error).
328  if (context->reply) {
329  debugs(11, 2, "drop 1xx made late by " << context->reply);
330  return false;
331  }
332 
333  const ClientHttpRequest *http = context->http;
334 
335  // apply selected clientReplyContext::buildReplyHeader() mods
336  // it is not clear what headers are required for control messages
338  // paranoid: ContentLengthInterpreter has cleaned non-generated replies
340  rep->header.putStr(Http::HdrType::CONNECTION, "keep-alive");
341  httpHdrMangleList(&rep->header, http->request, http->al, ROR_REPLY);
342 
343  MemBuf *mb = rep->pack();
344 
345  debugs(11, 2, "HTTP Client " << clientConnection);
346  debugs(11, 2, "HTTP Client CONTROL MSG:\n---------\n" << mb->buf << "\n----------");
347 
348  Comm::Write(clientConnection, mb, call);
349 
350  delete mb;
351  return true;
352 }
353 
356 {
357  return new Http1::Server(xact, false);
358 }
359 
362 {
363  return new Http1::Server(xact, true);
364 }
365 
int delById(Http::HdrType id)
Definition: HttpHeader.cc:681
AnyP::ProtocolVersion ProtocolVersion(unsigned int aMajor, unsigned int aMinor)
HTTP version label information.
int has(Http::HdrType id) const
Definition: HttpHeader.cc:1011
void clientProcessRequestFinished(ConnStateData *conn, const HttpRequest::Pointer &request)
#define JobCallback(dbgSection, dbgLevel, Dialer, job, method)
Convenience macro to create a Dialer-based job callback.
Definition: AsyncJobCalls.h:68
bool buildHttpRequest(Http::StreamPointer &context)
Definition: Http1Server.cc:94
#define CBDATA_NAMESPACED_CLASS_INIT(namespace, type)
Definition: cbdata.h:326
#define assert(EX)
Definition: assert.h:17
bool isOpen(const int fd)
Definition: comm.cc:86
int caseCmp(char const *) const
Definition: String.cc:299
ConnStateData * NewServer(MasterXactionPointer &xact)
create a new HTTP connection handler; never returns NULL
Definition: Http1Server.cc:355
Definition: Server.h:28
void setReplyToError(err_type, Http::StatusCode, const HttpRequestMethod &, char const *, Ip::Address &, HttpRequest *, const char *, Auth::UserRequest::Pointer)
builds error using clientBuildError() and calls setReplyToError() below
void set(const AnyP::ProtocolVersion &newVersion, Http::StatusCode newStatus, const char *newReason=NULL)
Definition: StatusLine.cc:30
virtual void processParsedRequest(Http::StreamPointer &context)
start processing a freshly parsed request
Definition: Http1Server.cc:232
Definition: SBuf.h:86
virtual time_t idleTimeout() const
timeout to use when waiting for the next request
Definition: Http1Server.cc:35
HttpRequestMethod method
Definition: HttpRequest.h:106
acl_access * forceRequestBodyContinuation
Definition: SquidConfig.h:403
struct _request * request(char *urlin)
Definition: tcp-banger2.c:291
void removeHopByHopEntries()
Definition: HttpHeader.cc:1722
MemBuf * pack() const
Definition: HttpReply.cc:111
void proceedAfterBodyContinuation(Http::StreamPointer context)
Definition: Http1Server.cc:225
bool forcedBodyContinuation
whether we have responded with HTTP 100 or FTP 150 already
Definition: HttpRequest.h:187
AccessLogEntry::Pointer al
info for the future access.log, and external ACL
void HTTPMSGLOCK(Http::Message *a)
Definition: Message.h:157
#define Must(condition)
Like assert() but throws an exception instead of aborting the process.
Definition: TextException.h:69
int conn
the current server connection FD
Definition: Transport.cc:26
void requestTimeout(const CommTimeoutCbParams &params)
AsyncCall * asyncCall(int aDebugSection, int aDebugLevel, const char *aName, const Dialer &aDialer)
Definition: AsyncCall.h:156
virtual void handleReply(HttpReply *rep, StoreIOBuffer receivedData)
Definition: Http1Server.cc:287
NotePairs::Pointer notes()
Definition: HttpRequest.cc:695
Definition: parse.c:104
StatusCode
Definition: StatusCode.h:20
#define debugs(SECTION, LEVEL, CONTENT)
Definition: Debug.h:124
HttpReply * reply
void clientProcessRequest(ConnStateData *conn, const Http1::RequestParserPointer &hp, Http::Stream *context)
Manages a connection from an HTTP/1 or HTTP/0.9 client.
Definition: Http1Server.h:20
ConnStateData * NewServer(MasterXactionPointer &xact)
create a new HTTPS connection handler; never returns NULL
Definition: Http1Server.cc:361
bool streamError
Definition: RequestFlags.h:94
Server(const MasterXaction::Pointer &xact, const bool beHttpsServer)
Definition: Http1Server.cc:27
void setLogUriToRawUri(const char *rawUri, const HttpRequestMethod &)
String getList(Http::HdrType id) const
Definition: HttpHeader.cc:828
bool chunkedReply
Definition: RequestFlags.h:92
StoreEntry * storeEntry() const
bundles HTTP 1xx reply and the &quot;successfully forwarded&quot; callback
AnyP::Uri url
the request URI
Definition: HttpRequest.h:107
Http::Stream * parseHttpRequest(ConnStateData *csd, const Http1::RequestParserPointer &hp)
struct SquidConfig::@113 accessList
bool parseHeader(Http1::Parser &hp)
Definition: HttpRequest.cc:654
uint16_t flags
Definition: Store.h:208
bool hasNotes() const
Definition: HttpRequest.h:237
ClientStreamData data
Definition: clientStream.h:94
AccessLogEntry::Pointer al
access.log entry
Http::StatusLine sline
Definition: HttpReply.h:60
virtual void noteBodyConsumerAborted(BodyPipe::Pointer)
Definition: Http1Server.cc:280
time_t request_start_timeout
Definition: SquidConfig.h:119
virtual void noteMoreBodySpaceAvailable(BodyPipe::Pointer)
Definition: Http1Server.cc:60
static HttpRequest * FromUrl(const char *url, const MasterXaction::Pointer &, const HttpRequestMethod &method=Http::METHOD_GET)
Definition: HttpRequest.cc:523
HttpHeader header
Definition: Message.h:74
char * buf
Definition: MemBuf.h:134
RequestFlags flags
Definition: HttpRequest.h:133
void putStr(Http::HdrType id, const char *str)
Definition: HttpHeader.cc:1072
#define PROF_start(probename)
Definition: Profiler.h:62
virtual Http::Stream * parseOneRequest()
Definition: Http1Server.cc:73
size_t HttpReply *STUB StoreEntry const KeyScope scope const HttpRequestMethod & method
Definition: stub_store.cc:122
time_t clientIdlePconn
Definition: SquidConfig.h:113
Definition: MemBuf.h:23
struct SquidConfig::@98 Timeout
void setReplyError(Http::StreamPointer &context, HttpRequest::Pointer &request, const HttpRequestMethod &method, err_type requestError, Http::StatusCode errStatusCode, const char *requestErrorBytes)
Definition: Http1Server.cc:206
HttpRequest *const request
#define PROF_stop(probename)
Definition: Profiler.h:63
void initRequest(HttpRequest *)
virtual void start()
called by AsyncStart; do not call directly
Definition: Http1Server.cc:41
virtual bool writeControlMsgAndCall(HttpReply *rep, AsyncCall::Pointer &call)
handle a control message received by context from a peer and call back
Definition: Http1Server.cc:321
SBuf & authority(bool requirePort=false) const
Definition: Uri.cc:470
bool clientTunnelOnError(ConnStateData *conn, Http::StreamPointer &context, HttpRequest::Pointer &request, const HttpRequestMethod &method, err_type requestError)
void removeIrrelevantContentLength()
Some response status codes prohibit sending Content-Length (RFC 7230 section 3.3.2).
Definition: HttpReply.cc:667
int commSetConnTimeout(const Comm::ConnectionPointer &conn, int timeout, AsyncCall::Pointer &callback)
Definition: comm.cc:552
#define EBIT_TEST(flag, bit)
Definition: defines.h:107
C * getRaw() const
Definition: RefCount.h:74
Comm::ConnectionPointer tcpClient
the client TCP connection which originated this transaction
Definition: MasterXaction.h:53
class SquidConfig Config
Definition: SquidConfig.cc:12
void append(const NotePairs *src)
Append the entries of the src NotePairs list to our list.
Definition: Notes.cc:342
#define NULL
Definition: types.h:166
void httpHdrMangleList(HttpHeader *l, HttpRequest *request, const AccessLogEntryPointer &al, req_or_rep_t req_or_rep)
void Write(const Comm::ConnectionPointer &conn, const char *buf, int size, AsyncCall::Pointer &callback, FREE *free_func)
Definition: Write.cc:35
virtual void start()
called by AsyncStart; do not call directly
virtual void noteBodyConsumerAborted(BodyPipe::Pointer)=0
err_type
Definition: err_type.h:12

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors