1
0
Fork 0

Split Http- and HttpsCommTask

add .ctags_exclude and new CommTasks

move some code form GeneralCommTask to HttpCommTask

move more code into HttpCommTask

fix ording or initialization

if access of classes

make _requestAsHttp() private

more cleanup
This commit is contained in:
Jan Christoph Uhde 2016-07-22 11:02:20 +02:00
parent 5edaf0043a
commit b8c705868e
12 changed files with 1078 additions and 1239 deletions

7
.ctags_exclude Normal file
View File

@ -0,0 +1,7 @@
Installation
out
3rdParty
Documentation
js/node/node_modules
.git
.svn

3
.gitignore vendored
View File

@ -3,6 +3,7 @@ build
core.*
build.sh
*.vim
.deps
.dirstamp
*.o
@ -27,6 +28,8 @@ build.sh
Thumbs.db
testresult.json
botschaft.txt
testsStarted
build*/
Build64/

File diff suppressed because it is too large Load Diff

View File

@ -32,10 +32,9 @@
#include "Basics/WorkItem.h"
#include <deque>
namespace arangodb {
class HttpRequest;
class HttpResponse;
class GeneralRequest;
class GeneralResponse;
namespace rest {
class GeneralServer;
@ -44,171 +43,59 @@ class GeneralCommTask : public SocketTask, public RequestStatisticsAgent {
GeneralCommTask(GeneralCommTask const&) = delete;
GeneralCommTask const& operator=(GeneralCommTask const&) = delete;
public:
static size_t const MaximalHeaderSize;
static size_t const MaximalBodySize;
static size_t const MaximalPipelineSize;
static size_t const RunCompactEvery;
public:
GeneralCommTask(GeneralServer*, TRI_socket_t, ConnectionInfo&&,
double keepAliveTimeout);
protected:
~GeneralCommTask();
public:
// return whether or not the task desires to start a dispatcher thread
bool startThread() const { return _startThread; }
bool startThread() const { return _startThread; } // called by server
void handleResponse(GeneralResponse*); // called by server
// handles response
void handleResponse(HttpResponse*);
// handles simple errors
void handleSimpleError(GeneralResponse::ResponseCode);
void handleSimpleError(GeneralResponse::ResponseCode, int code,
std::string const& errorMessage);
// reads data from the socket
bool processRead();
// sends more chunked data
void sendChunk(basics::StringBuffer*);
// chunking is finished
void finishedChunked();
// task set up complete
void setupDone();
void setupDone() { _setupDone.store(true, std::memory_order_relaxed); }
private:
// returns the authentication realm
std::string authenticationRealm() const;
protected:
virtual ~GeneralCommTask();
// checks the authentication
GeneralResponse::ResponseCode authenticateRequest();
virtual void addResponse(GeneralResponse*) = 0;
virtual bool processRead() = 0;
virtual void processRequest() = 0;
virtual void resetState(bool) = 0;
// reads data from the socket
void addResponse(HttpResponse*);
virtual bool handleEvent(EventToken token,
EventType events) override; // called by TODO
virtual bool setup(Scheduler* scheduler,
EventLoop loop) override; // called by
// check the content-length header of a request and fail it is broken
bool checkContentLength(bool expectContentLength);
// fills the write buffer
void fillWriteBuffer();
// handles CORS options
void processCorsOptions();
// processes a request
void processRequest();
void cleanup() override final { SocketTask::cleanup(); }
// clears the request object
void clearRequest();
// resets the internal state
//
// this method can be called to clean up when the request handling aborts
// prematurely
void resetState(bool close);
protected:
bool setup(Scheduler* scheduler, EventLoop loop) override;
void cleanup() override;
bool handleEvent(EventToken token, EventType events) override;
void signalTask(TaskData*) override;
protected:
bool handleRead() override;
void completedWriteBuffer() override;
void handleTimeout() override;
protected:
// connection info
ConnectionInfo _connectionInfo;
// the underlying server
GeneralServer* const _server;
// allow method override
bool _allowMethodOverride;
char const* _protocol;
void clearRequest() {
delete _request;
_request = nullptr;
}
private:
// write buffers
std::deque<basics::StringBuffer*> _writeBuffers;
// statistics buffers
std::deque<TRI_request_statistics_t*> _writeBuffersStats;
// current read position
size_t _readPosition;
// start of the body position
size_t _bodyPosition;
// body length
size_t _bodyLength;
// true if request is complete but not handled
bool _requestPending;
// true if a close has been requested by the client
bool _closeRequested;
// true if reading the request body
bool _readRequestBody;
// whether or not to allow credentialed requests (only CORS)
bool _denyCredentials;
// whether the client accepts deflate algorithm
bool _acceptDeflate;
// new request started
bool _newRequest;
// true if within a chunked response
bool _isChunked;
//////////////////////////////////////////////////////////////////////////////
/// @brief start a separate thread if the task is added to the dispatcher?
//////////////////////////////////////////////////////////////////////////////
void handleTimeout() override final;
protected:
GeneralServer* const _server;
GeneralRequest* _request; // the request with possible incomplete body
ConnectionInfo _connectionInfo;
char const* _protocol; // protocal to use http, vpp
GeneralRequest::ProtocolVersion _protocolVersion;
bool _startThread;
// the request with possible incomplete body
HttpRequest* _request;
// http version number used
GeneralRequest::ProtocolVersion _httpVersion;
// type of request (GET, POST, ...)
GeneralRequest::RequestType _requestType;
// value of requested URL
std::string _fullUrl;
// value of the HTTP origin header the client sent (if any, CORS only)
std::string _origin;
// start position of current request
size_t _startPosition;
// number of requests since last compactification
size_t _sinceCompactification;
// original body length
size_t _originalBodyLength;
// task ready
std::atomic<bool> _setupDone;
// authentication real
std::string const _authenticationRealm;
}; // Commontask
std::deque<basics::StringBuffer*> _writeBuffers;
std::deque<TRI_request_statistics_t*>
_writeBuffersStats; // statistics buffers
bool _isChunked; // true if within a chunked response
bool _requestPending; // true if request is complete but not handled
std::atomic<bool> _setupDone; // task ready
}; // Commontask
} // rest
} // arango

View File

@ -0,0 +1,954 @@
#include "GeneralServer/HttpCommTask.h"
#include "GeneralServer/GeneralServer.h"
#include "GeneralServer/RestHandler.h"
#include "GeneralServer/RestHandlerFactory.h"
#include "RestServer/RestServerFeature.h"
#include "Scheduler/Scheduler.h"
#include "Scheduler/SchedulerFeature.h"
#include "Basics/HybridLogicalClock.h"
#include "VocBase/server.h" //clock
////////////////////////////////////////////////////////////////////////////////
/// @brief reads data from the socket
////////////////////////////////////////////////////////////////////////////////
using namespace arangodb;
using namespace arangodb::basics;
using namespace arangodb::rest;
namespace arangodb {
class HttpRequest;
class HttpResponse;
namespace rest {
class GeneralServer;
size_t const HttpCommTask::MaximalHeaderSize = 1 * 1024 * 1024; // 1 MB
size_t const HttpCommTask::MaximalBodySize = 512 * 1024 * 1024; // 512 MB
size_t const HttpCommTask::MaximalPipelineSize = 512 * 1024 * 1024; // 512 MB
size_t const HttpCommTask::RunCompactEvery = 500;
HttpCommTask::HttpCommTask(GeneralServer* server, TRI_socket_t sock,
ConnectionInfo&& info, double timeout)
: Task("HttpCommTask"),
GeneralCommTask(server, sock, std::move(info), timeout),
_readPosition(0),
_startPosition(0),
_bodyPosition(0),
_bodyLength(0),
_closeRequested(false),
_readRequestBody(false),
_allowMethodOverride(server->allowMethodOverride()),
_denyCredentials(true),
_acceptDeflate(false),
_newRequest(true),
_requestType(GeneralRequest::RequestType::ILLEGAL),
_fullUrl(),
_origin(),
_sinceCompactification(0),
_originalBodyLength(0)
{
_protocol = "http";
connectionStatisticsAgentSetHttp();
}
void HttpCommTask::addResponse(HttpResponse* response) {
// CORS response handling
if (!_origin.empty()) {
// the request contained an Origin header. We have to send back the
// access-control-allow-origin header now
LOG(TRACE) << "handling CORS response";
response->setHeaderNC(StaticStrings::AccessControlExposeHeaders,
StaticStrings::ExposedCorsHeaders);
// send back original value of "Origin" header
response->setHeaderNC(StaticStrings::AccessControlAllowOrigin, _origin);
// send back "Access-Control-Allow-Credentials" header
response->setHeaderNC(StaticStrings::AccessControlAllowCredentials,
(_denyCredentials ? "false" : "true"));
}
// CORS request handling EOF
// set "connection" header
// keep-alive is the default
response->setConnectionType(_closeRequested
? HttpResponse::CONNECTION_CLOSE
: HttpResponse::CONNECTION_KEEP_ALIVE);
size_t const responseBodyLength = response->bodySize();
if (_requestType == GeneralRequest::RequestType::HEAD) {
// clear body if this is an HTTP HEAD request
// HEAD must not return a body
response->headResponse(responseBodyLength);
}
// else {
// // to enable automatic deflating of responses, activate this.
// // deflate takes a lot of CPU time so it should only be enabled for
// // dedicated purposes and not generally
// if (responseBodyLength > 16384 && _acceptDeflate) {
// response->deflate();
// responseBodyLength = response->bodySize();
// }
// }
// reserve a buffer with some spare capacity
auto buffer = std::make_unique<StringBuffer>(TRI_UNKNOWN_MEM_ZONE,
responseBodyLength + 128, false);
// write header
response->writeHeader(buffer.get());
// write body
if (_requestType != GeneralRequest::RequestType::HEAD) {
if (_isChunked) {
if (0 != responseBodyLength) {
buffer->appendHex(response->body().length());
buffer->appendText(TRI_CHAR_LENGTH_PAIR("\r\n"));
buffer->appendText(response->body());
buffer->appendText(TRI_CHAR_LENGTH_PAIR("\r\n"));
}
} else {
buffer->appendText(response->body());
}
}
buffer->ensureNullTerminated();
_writeBuffers.push_back(buffer.get());
auto b = buffer.release();
if (!b->empty()) {
LOG_TOPIC(TRACE, Logger::REQUESTS)
<< "\"http-request-response\",\"" << (void*)this << "\",\""
<< StringUtils::escapeUnicode(std::string(b->c_str(), b->length()))
<< "\"";
}
// clear body
response->body().clear();
double const totalTime = RequestStatisticsAgent::elapsedSinceReadStart();
_writeBuffersStats.push_back(RequestStatisticsAgent::steal());
LOG_TOPIC(INFO, Logger::REQUESTS)
<< "\"http-request-end\",\"" << (void*)this << "\",\""
<< _connectionInfo.clientAddress << "\",\""
<< HttpRequest::translateMethod(_requestType) << "\",\""
<< HttpRequest::translateVersion(_protocolVersion) << "\","
<< static_cast<int>(response->responseCode()) << ","
<< _originalBodyLength << "," << responseBodyLength << ",\"" << _fullUrl
<< "\"," << Logger::FIXED(totalTime, 6);
// start output
fillWriteBuffer();
} // addResponse
////////////////////////////////////////////////////////////////////////////////
/// @brief reads data from the socket
////////////////////////////////////////////////////////////////////////////////
bool HttpCommTask::processRead() {
if (_requestPending || _readBuffer->c_str() == nullptr) {
return false;
}
bool handleRequest = false;
// still trying to read the header fields
if (!_readRequestBody) {
char const* ptr = _readBuffer->c_str() + _readPosition;
char const* etr = _readBuffer->end();
if (ptr == etr) {
return false;
}
// starting a new request
if (_newRequest) {
// acquire a new statistics entry for the request
RequestStatisticsAgent::acquire();
#if USE_DEV_TIMERS
if (RequestStatisticsAgent::_statistics != nullptr) {
RequestStatisticsAgent::_statistics->_id = (void*)this;
}
#endif
_newRequest = false;
_startPosition = _readPosition;
_protocolVersion = GeneralRequest::ProtocolVersion::UNKNOWN;
_requestType = GeneralRequest::RequestType::ILLEGAL;
_fullUrl = "";
_denyCredentials = true;
_acceptDeflate = false;
_sinceCompactification++;
}
char const* end = etr - 3;
// read buffer contents are way to small. we can exit here directly
if (ptr >= end) {
return false;
}
// request started
requestStatisticsAgentSetReadStart();
// check for the end of the request
for (; ptr < end; ptr++) {
if (ptr[0] == '\r' && ptr[1] == '\n' && ptr[2] == '\r' &&
ptr[3] == '\n') {
break;
}
}
// check if header is too large
size_t headerLength = ptr - (_readBuffer->c_str() + _startPosition);
if (headerLength > MaximalHeaderSize) {
LOG(WARN) << "maximal header size is " << MaximalHeaderSize
<< ", request header size is " << headerLength;
// header is too large
handleSimpleError(
GeneralResponse::ResponseCode::REQUEST_HEADER_FIELDS_TOO_LARGE);
return false;
}
// header is complete
if (ptr < end) {
_readPosition = ptr - _readBuffer->c_str() + 4;
LOG(TRACE) << "HTTP READ FOR " << (void*)this << ": "
<< std::string(_readBuffer->c_str() + _startPosition,
_readPosition - _startPosition);
// check that we know, how to serve this request and update the connection
// information, i. e. client and server addresses and ports and create a
// request context for that request
_request = new HttpRequest(
_connectionInfo, _readBuffer->c_str() + _startPosition,
_readPosition - _startPosition, _allowMethodOverride);
if (_request == nullptr) {
LOG(ERR) << "cannot generate request";
// internal server error
handleSimpleError(GeneralResponse::ResponseCode::SERVER_ERROR);
return false;
}
RestServerFeature::HANDLER_FACTORY->setRequestContext(_request);
_request->setClientTaskId(_taskId);
// check HTTP protocol version
_protocolVersion = _request->protocolVersion();
if (_protocolVersion != GeneralRequest::ProtocolVersion::HTTP_1_0 &&
_protocolVersion != GeneralRequest::ProtocolVersion::HTTP_1_1) {
handleSimpleError(
GeneralResponse::ResponseCode::HTTP_VERSION_NOT_SUPPORTED);
return false;
}
// check max URL length
_fullUrl = _request->fullUrl();
if (_fullUrl.size() > 16384) {
handleSimpleError(GeneralResponse::ResponseCode::REQUEST_URI_TOO_LONG);
return false;
}
// update the connection information, i. e. client and server addresses
// and ports
_request->setProtocol(_protocol);
LOG(TRACE) << "server port " << _connectionInfo.serverPort
<< ", client port " << _connectionInfo.clientPort;
// set body start to current position
_bodyPosition = _readPosition;
_bodyLength = 0;
// keep track of the original value of the "origin" request header (if
// any), we need this value to handle CORS requests
_origin = _request->header(StaticStrings::Origin);
if (!_origin.empty()) {
// check for Access-Control-Allow-Credentials header
bool found;
std::string const& allowCredentials = _request->header(
StaticStrings::AccessControlAllowCredentials, found);
if (found) {
// default is to allow nothing
_denyCredentials = true;
// if the request asks to allow credentials, we'll check against the
// configured whitelist of origins
std::vector<std::string> const& accessControlAllowOrigins =
_server->trustedOrigins();
if (StringUtils::boolean(allowCredentials) &&
!accessControlAllowOrigins.empty()) {
if (accessControlAllowOrigins[0] == "*") {
// special case: allow everything
_denyCredentials = false;
} else if (!_origin.empty()) {
// copy origin string
if (_origin[_origin.size() - 1] == '/') {
// strip trailing slash
auto result = std::find(accessControlAllowOrigins.begin(),
accessControlAllowOrigins.end(),
_origin.substr(0, _origin.size() - 1));
_denyCredentials = (result == accessControlAllowOrigins.end());
} else {
auto result =
std::find(accessControlAllowOrigins.begin(),
accessControlAllowOrigins.end(), _origin);
_denyCredentials = (result == accessControlAllowOrigins.end());
}
} else {
TRI_ASSERT(_denyCredentials);
}
}
}
}
// store the original request's type. we need it later when responding
// (original request object gets deleted before responding)
_requestType = _request->requestType();
requestStatisticsAgentSetRequestType(_requestType);
// handle different HTTP methods
switch (_requestType) {
case GeneralRequest::RequestType::GET:
case GeneralRequest::RequestType::DELETE_REQ:
case GeneralRequest::RequestType::HEAD:
case GeneralRequest::RequestType::OPTIONS:
case GeneralRequest::RequestType::POST:
case GeneralRequest::RequestType::PUT:
case GeneralRequest::RequestType::PATCH: {
// technically, sending a body for an HTTP DELETE request is not
// forbidden, but it is not explicitly supported
bool const expectContentLength =
(_requestType == GeneralRequest::RequestType::POST ||
_requestType == GeneralRequest::RequestType::PUT ||
_requestType == GeneralRequest::RequestType::PATCH ||
_requestType == GeneralRequest::RequestType::OPTIONS ||
_requestType == GeneralRequest::RequestType::DELETE_REQ);
if (!checkContentLength(expectContentLength)) {
return false;
}
if (_bodyLength == 0) {
handleRequest = true;
}
break;
}
default: {
size_t l = _readPosition - _startPosition;
if (6 < l) {
l = 6;
}
LOG(WARN) << "got corrupted HTTP request '"
<< std::string(_readBuffer->c_str() + _startPosition, l)
<< "'";
// force a socket close, response will be ignored!
TRI_CLOSE_SOCKET(_commSocket);
TRI_invalidatesocket(&_commSocket);
// bad request, method not allowed
handleSimpleError(GeneralResponse::ResponseCode::METHOD_NOT_ALLOWED);
return false;
}
}
// .............................................................................
// check if server is active
// .............................................................................
Scheduler const* scheduler = SchedulerFeature::SCHEDULER;
if (scheduler != nullptr && !scheduler->isActive()) {
// server is inactive and will intentionally respond with HTTP 503
LOG(TRACE) << "cannot serve request - server is inactive";
handleSimpleError(GeneralResponse::ResponseCode::SERVICE_UNAVAILABLE);
return false;
}
// check for a 100-continue
if (_readRequestBody) {
bool found;
std::string const& expect =
_request->header(StaticStrings::Expect, found);
if (found && StringUtils::trim(expect) == "100-continue") {
LOG(TRACE) << "received a 100-continue request";
auto buffer = std::make_unique<StringBuffer>(TRI_UNKNOWN_MEM_ZONE);
buffer->appendText(
TRI_CHAR_LENGTH_PAIR("HTTP/1.1 100 (Continue)\r\n\r\n"));
buffer->ensureNullTerminated();
_writeBuffers.push_back(buffer.get());
buffer.release();
_writeBuffersStats.push_back(nullptr);
fillWriteBuffer();
}
}
} else {
size_t l = (_readBuffer->end() - _readBuffer->c_str());
if (_startPosition + 4 <= l) {
_readPosition = l - 4;
}
}
}
// readRequestBody might have changed, so cannot use else
if (_readRequestBody) {
if (_readBuffer->length() - _bodyPosition < _bodyLength) {
setKeepAliveTimeout(_keepAliveTimeout);
// let client send more
return false;
}
// read "bodyLength" from read buffer and add this body to "httpRequest"
_requestAsHttp()->setBody(_readBuffer->c_str() + _bodyPosition,
_bodyLength);
LOG(TRACE) << "" << std::string(_readBuffer->c_str() + _bodyPosition,
_bodyLength);
// remove body from read buffer and reset read position
_readRequestBody = false;
handleRequest = true;
}
// .............................................................................
// request complete
//
// we have to delete request in here or pass it to a handler, which will
// delete
// it
// .............................................................................
if (!handleRequest) {
return false;
}
requestStatisticsAgentSetReadEnd();
requestStatisticsAgentAddReceivedBytes(_bodyPosition - _startPosition +
_bodyLength);
bool const isOptionsRequest =
(_requestType == GeneralRequest::RequestType::OPTIONS);
resetState(false);
// .............................................................................
// keep-alive handling
// .............................................................................
std::string connectionType =
StringUtils::tolower(_request->header(StaticStrings::Connection));
if (connectionType == "close") {
// client has sent an explicit "Connection: Close" header. we should close
// the connection
LOG(DEBUG) << "connection close requested by client";
_closeRequested = true;
} else if (_requestAsHttp()->isHttp10() && connectionType != "keep-alive") {
// HTTP 1.0 request, and no "Connection: Keep-Alive" header sent
// we should close the connection
LOG(DEBUG) << "no keep-alive, connection close requested by client";
_closeRequested = true;
} else if (_keepAliveTimeout <= 0.0) {
// if keepAliveTimeout was set to 0.0, we'll close even keep-alive
// connections immediately
LOG(DEBUG) << "keep-alive disabled by admin";
_closeRequested = true;
}
// we keep the connection open in all other cases (HTTP 1.1 or Keep-Alive
// header sent)
// .............................................................................
// authenticate
// .............................................................................
GeneralResponse::ResponseCode authResult = authenticateRequest();
// authenticated or an OPTIONS request. OPTIONS requests currently go
// unauthenticated
if (authResult == GeneralResponse::ResponseCode::OK || isOptionsRequest) {
// handle HTTP OPTIONS requests directly
if (isOptionsRequest) {
processCorsOptions();
} else {
processRequest();
}
}
// not found
else if (authResult == GeneralResponse::ResponseCode::NOT_FOUND) {
handleSimpleError(authResult, TRI_ERROR_ARANGO_DATABASE_NOT_FOUND,
TRI_errno_string(TRI_ERROR_ARANGO_DATABASE_NOT_FOUND));
}
// forbidden
else if (authResult == GeneralResponse::ResponseCode::FORBIDDEN) {
handleSimpleError(authResult, TRI_ERROR_USER_CHANGE_PASSWORD,
"change password");
}
// not authenticated
else {
HttpResponse response(GeneralResponse::ResponseCode::UNAUTHORIZED);
std::string realm = "Bearer token_type=\"JWT\", realm=\"ArangoDB\"";
response.setHeaderNC(StaticStrings::WwwAuthenticate, std::move(realm));
clearRequest();
handleResponse(&response);
}
return true;
} // processsRead
////////////////////////////////////////////////////////////////////////////////
/// @brief processes a request
////////////////////////////////////////////////////////////////////////////////
void HttpCommTask::processRequest() {
// check for deflate
bool found;
auto httpRequest = _requestAsHttp();
std::string const& acceptEncoding =
httpRequest->header(StaticStrings::AcceptEncoding, found);
if (found) {
if (acceptEncoding.find("deflate") != std::string::npos) {
_acceptDeflate = true;
}
}
if (httpRequest != nullptr) {
LOG_TOPIC(DEBUG, Logger::REQUESTS)
<< "\"http-request-begin\",\"" << (void*)this << "\",\""
<< _connectionInfo.clientAddress << "\",\""
<< HttpRequest::translateMethod(_requestType) << "\",\""
<< HttpRequest::translateVersion(_protocolVersion) << "\"," << _fullUrl
<< "\"";
std::string const& body = httpRequest->body();
if (!body.empty()) {
LOG_TOPIC(DEBUG, Logger::REQUESTS)
<< "\"http-request-body\",\"" << (void*)this << "\",\""
<< (StringUtils::escapeUnicode(body)) << "\"";
}
}
// check for an HLC time stamp
std::string const& timeStamp =
_request->header(StaticStrings::HLCHeader, found);
if (found) {
uint64_t timeStampInt =
arangodb::basics::HybridLogicalClock::decodeTimeStampWithCheck(
timeStamp);
if (timeStampInt != 0) {
TRI_HybridLogicalClock(timeStampInt);
}
}
// check for an async request
std::string const& asyncExecution =
_request->header(StaticStrings::Async, found);
// create handler, this will take over the request and the response
std::unique_ptr<HttpResponse> response(
new HttpResponse(GeneralResponse::ResponseCode::SERVER_ERROR));
// execute response
WorkItem::uptr<RestHandler> handler(
RestServerFeature::HANDLER_FACTORY->createHandler(_request,
response.get()));
// ab hier generell
if (handler == nullptr) {
LOG(TRACE) << "no handler is known, giving up";
clearRequest();
handleSimpleError(GeneralResponse::ResponseCode::NOT_FOUND);
return;
}
response.release();
if (_request != nullptr) {
bool found;
std::string const& startThread =
_request->header(StaticStrings::StartThread, found);
if (found) {
_startThread = StringUtils::boolean(startThread);
}
}
handler->setTaskId(_taskId, _loop);
// clear request object
_request = nullptr;
// async execution
bool ok = false;
if (found && (asyncExecution == "true" || asyncExecution == "store")) {
requestStatisticsAgentSetAsync();
uint64_t jobId = 0;
if (asyncExecution == "store") {
// persist the responses
ok = _server->handleRequestAsync(this, handler, &jobId);
} else {
// don't persist the responses
ok = _server->handleRequestAsync(this, handler, nullptr);
}
if (ok) {
HttpResponse response(GeneralResponse::ResponseCode::ACCEPTED);
if (jobId > 0) {
// return the job id we just created
response.setHeaderNC(StaticStrings::AsyncId, StringUtils::itoa(jobId));
}
handleResponse(&response);
return;
}
}
// synchronous request
else {
ok = _server->handleRequest(this, handler);
}
if (!ok) {
handleSimpleError(GeneralResponse::ResponseCode::SERVER_ERROR);
}
} // processRequest
////////////////////////////////////////////////////////////////////////////////
/// @brief chunking is finished
////////////////////////////////////////////////////////////////////////////////
void HttpCommTask::finishedChunked() {
auto buffer = std::make_unique<StringBuffer>(TRI_UNKNOWN_MEM_ZONE, 6, true);
buffer->appendText(TRI_CHAR_LENGTH_PAIR("0\r\n\r\n"));
buffer->ensureNullTerminated();
_writeBuffers.push_back(buffer.get());
buffer.release();
_writeBuffersStats.push_back(nullptr);
_isChunked = false;
_startThread = false;
_requestPending = false;
fillWriteBuffer();
processRead();
}
////////////////////////////////////////////////////////////////////////////////
/// check the content-length header of a request and fail it is broken
////////////////////////////////////////////////////////////////////////////////
bool HttpCommTask::checkContentLength(bool expectContentLength) {
int64_t const bodyLength = _request->contentLength();
if (bodyLength < 0) {
// bad request, body length is < 0. this is a client error
handleSimpleError(GeneralResponse::ResponseCode::LENGTH_REQUIRED);
return false;
}
if (!expectContentLength && bodyLength > 0) {
// content-length header was sent but the request method does not support
// that
// we'll warn but read the body anyway
LOG(WARN) << "received HTTP GET/HEAD request with content-length, this "
"should not happen";
}
if ((size_t)bodyLength > MaximalBodySize) {
LOG(WARN) << "maximal body size is " << MaximalBodySize
<< ", request body size is " << bodyLength;
// request entity too large
handleSimpleError(GeneralResponse::ResponseCode::REQUEST_ENTITY_TOO_LARGE);
return false;
}
// set instance variable to content-length value
_bodyLength = (size_t)bodyLength;
_originalBodyLength = _bodyLength;
if (_bodyLength > 0) {
// we'll read the body
_readRequestBody = true;
}
// everything's fine
return true;
}
void HttpCommTask::fillWriteBuffer() {
if (!hasWriteBuffer() && !_writeBuffers.empty()) {
StringBuffer* buffer = _writeBuffers.front();
_writeBuffers.pop_front();
TRI_ASSERT(buffer != nullptr);
TRI_request_statistics_t* statistics = _writeBuffersStats.front();
_writeBuffersStats.pop_front();
setWriteBuffer(buffer, statistics);
}
}
void HttpCommTask::processCorsOptions() {
HttpResponse response(GeneralResponse::ResponseCode::OK);
response.setHeaderNC(StaticStrings::Allow, StaticStrings::CorsMethods);
if (!_origin.empty()) {
LOG(TRACE) << "got CORS preflight request";
std::string const allowHeaders = StringUtils::trim(
_request->header(StaticStrings::AccessControlRequestHeaders));
// send back which HTTP methods are allowed for the resource
// we'll allow all
response.setHeaderNC(StaticStrings::AccessControlAllowMethods,
StaticStrings::CorsMethods);
if (!allowHeaders.empty()) {
// allow all extra headers the client requested
// we don't verify them here. the worst that can happen is that the client
// sends some broken headers and then later cannot access the data on the
// server. that's a client problem.
response.setHeaderNC(StaticStrings::AccessControlAllowHeaders,
allowHeaders);
LOG(TRACE) << "client requested validation of the following headers: "
<< allowHeaders;
}
// set caching time (hard-coded value)
response.setHeaderNC(StaticStrings::AccessControlMaxAge,
StaticStrings::N1800);
}
clearRequest();
handleResponse(&response);
}
void HttpCommTask::signalTask(TaskData* data) {
// data response
if (data->_type == TaskData::TASK_DATA_RESPONSE) {
data->RequestStatisticsAgent::transferTo(this);
HttpResponse* response = dynamic_cast<HttpResponse*>(data->_response.get());
if (response != nullptr) {
handleResponse(response);
processRead();
} else {
handleSimpleError(GeneralResponse::ResponseCode::SERVER_ERROR);
}
}
// data response
else if (data->_type == TaskData::TASK_DATA_BUFFER) {
data->RequestStatisticsAgent::transferTo(this);
HttpResponse response(GeneralResponse::ResponseCode::OK);
velocypack::Slice slice(data->_buffer->data());
response.setPayload(_request, slice, true, VPackOptions::Defaults);
handleResponse(&response);
processRead();
}
// data chunk
else if (data->_type == TaskData::TASK_DATA_CHUNK) {
size_t len = data->_data.size();
if (0 == len) {
finishedChunked();
} else {
StringBuffer* buffer = new StringBuffer(TRI_UNKNOWN_MEM_ZONE, len);
buffer->appendHex(len);
buffer->appendText(TRI_CHAR_LENGTH_PAIR("\r\n"));
buffer->appendText(data->_data.c_str(), len);
buffer->appendText(TRI_CHAR_LENGTH_PAIR("\r\n"));
sendChunk(buffer);
}
}
// do not know, what to do - give up
else {
_scheduler->destroyTask(this);
}
}
bool HttpCommTask::handleRead() {
bool res = true;
if (!_setupDone.load(std::memory_order_relaxed)) return res;
if (!_closeRequested) {
res = fillReadBuffer();
// process as much data as we got
while (processRead()) {
if (_closeRequested) {
break;
}
}
} else {
// if we don't close here, the scheduler thread may fall into a
// busy wait state, consuming 100% CPU!
_clientClosed = true;
}
if (_clientClosed) {
res = false;
_server->handleCommunicationClosed(this);
} else if (!res) {
_clientClosed = true;
_server->handleCommunicationFailure(this);
}
return res;
}
void HttpCommTask::completedWriteBuffer() {
_writeBuffer = nullptr;
_writeLength = 0;
if (_writeBufferStatistics != nullptr) {
_writeBufferStatistics->_writeEnd = TRI_StatisticsTime();
TRI_ReleaseRequestStatistics(_writeBufferStatistics);
_writeBufferStatistics = nullptr;
}
fillWriteBuffer();
if (!_clientClosed && _closeRequested && !hasWriteBuffer() &&
_writeBuffers.empty() && !_isChunked) {
_clientClosed = true;
_server->handleCommunicationClosed(this);
}
}
void HttpCommTask::resetState(bool close) {
if (close) {
clearRequest();
_requestPending = false;
_isChunked = false;
_closeRequested = true;
_readPosition = 0;
_bodyPosition = 0;
_bodyLength = 0;
} else {
_requestPending = true;
bool compact = false;
if (_sinceCompactification > RunCompactEvery) {
compact = true;
} else if (_readBuffer->length() > MaximalPipelineSize) {
compact = true;
}
if (compact) {
_readBuffer->erase_front(_bodyPosition + _bodyLength);
_sinceCompactification = 0;
_readPosition = 0;
} else {
_readPosition = _bodyPosition + _bodyLength;
if (_readPosition == _readBuffer->length()) {
_sinceCompactification = 0;
_readPosition = 0;
_readBuffer->reset();
}
}
_bodyPosition = 0;
_bodyLength = 0;
}
_newRequest = true;
_readRequestBody = false;
_startThread = false;
}
GeneralResponse::ResponseCode HttpCommTask::authenticateRequest() {
auto context = (_request == nullptr) ? nullptr : _request->requestContext();
if (context == nullptr && _request != nullptr) {
bool res = RestServerFeature::HANDLER_FACTORY->setRequestContext(_request);
if (!res) {
return GeneralResponse::ResponseCode::NOT_FOUND;
}
context = _request->requestContext();
}
if (context == nullptr) {
return GeneralResponse::ResponseCode::SERVER_ERROR;
}
return context->authenticate();
}
void HttpCommTask::sendChunk(StringBuffer* buffer) {
if (_isChunked) {
TRI_ASSERT(buffer != nullptr);
_writeBuffers.push_back(buffer);
_writeBuffersStats.push_back(nullptr);
fillWriteBuffer();
} else {
delete buffer;
}
}
// convert internal GeneralRequest to HttpRequest
HttpRequest* HttpCommTask::_requestAsHttp() {
HttpRequest* request = dynamic_cast<HttpRequest*>(_request);
if (request == nullptr) {
// everything is borken FIXME
}
return request;
};
} // rest
} // arangodb

View File

@ -7,12 +7,72 @@ namespace rest {
class HttpCommTask : public GeneralCommTask {
public:
HttpCommTask(GeneralServer* serv, TRI_socket_t sock, ConnectionInfo&& info,
double timeout)
: Task("HttpCommTask"),
GeneralCommTask(serv, sock, std::move(info), timeout) {
_protocol = "http";
}
static size_t const MaximalHeaderSize;
static size_t const MaximalBodySize;
static size_t const MaximalPipelineSize;
static size_t const RunCompactEvery;
public:
HttpCommTask(GeneralServer*, TRI_socket_t, ConnectionInfo&&, double timeout);
bool processRead() override;
virtual void processRequest() override;
void addResponse(GeneralResponse* response) override {
// convert from GeneralResponse to httpResponse ad dispatch request to class
// internal addResponse
HttpResponse* httpResponse = dynamic_cast<HttpResponse*>(response);
if (httpResponse == nullptr) {
// everything is borken
}
addResponse(httpResponse);
};
protected:
void completedWriteBuffer() override final;
private:
void signalTask(TaskData*) override final;
// resets the internal state
// this method can be called to clean up when the request handling aborts
// prematurely
virtual void resetState(bool close) override final;
HttpRequest* _requestAsHttp();
void addResponse(HttpResponse*);
void finishedChunked();
// check the content-length header of a request and fail it is broken
bool checkContentLength(bool expectContentLength);
void fillWriteBuffer(); // fills the write buffer
void processCorsOptions(); // handles CORS options
std::string authenticationRealm() const; // returns the authentication realm
GeneralResponse::ResponseCode
authenticateRequest(); // checks the authentication
void sendChunk(basics::StringBuffer*); // sends more chunked data
bool handleRead() override final;
private:
size_t _readPosition; // current read position
size_t _startPosition; // start position of current request
size_t _bodyPosition; // start of the body position
size_t _bodyLength; // body length
bool _closeRequested; // true if a close has been requested by the client
bool _readRequestBody; // true if reading the request body
bool _allowMethodOverride; // allow method override
bool _denyCredentials; // whether or not to allow credentialed requests (only
// CORS)
bool _acceptDeflate; // whether the client accepts deflate algorithm
bool _newRequest; // new request started
GeneralRequest::RequestType _requestType; // type of request (GET, POST, ...)
std::string _fullUrl; // value of requested URL
std::string _origin; // value of the HTTP origin header the client sent (if
// any, CORS only)
size_t
_sinceCompactification; // number of requests since last compactification
size_t _originalBodyLength;
// authentication real
std::string const _authenticationRealm;
};
} // rest
} // arangodb

View File

@ -20,6 +20,7 @@
///
/// @author Dr. Frank Celler
/// @author Achim Brandt
// @author Jan Christoph Uhde
////////////////////////////////////////////////////////////////////////////////
#include "HttpsCommTask.h"
@ -35,10 +36,6 @@
using namespace arangodb;
using namespace arangodb::rest;
////////////////////////////////////////////////////////////////////////////////
/// @brief constructs a new task with a given socket
////////////////////////////////////////////////////////////////////////////////
HttpsCommTask::HttpsCommTask(GeneralServer* server, TRI_socket_t socket,
ConnectionInfo&& info, double keepAliveTimeout,
SSL_CTX* ctx, int verificationMode,
@ -56,10 +53,6 @@ HttpsCommTask::HttpsCommTask(GeneralServer* server, TRI_socket_t socket,
_tmpReadBuffer = new char[READ_BLOCK_SIZE];
}
////////////////////////////////////////////////////////////////////////////////
/// @brief destructs a task
////////////////////////////////////////////////////////////////////////////////
HttpsCommTask::~HttpsCommTask() {
shutdownSsl(true);

View File

@ -20,6 +20,7 @@
///
/// @author Dr. Frank Celler
/// @author Achim Brandt
// @author Jan Christoph Uhde
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGOD_HTTP_SERVER_HTTPS_COMM_TASK_H
@ -33,121 +34,44 @@ namespace arangodb {
namespace rest {
class GeneralServer;
////////////////////////////////////////////////////////////////////////////////
/// @brief https communication
////////////////////////////////////////////////////////////////////////////////
class HttpsCommTask : public HttpCommTask {
HttpsCommTask(HttpsCommTask const&) = delete;
HttpsCommTask const& operator=(HttpsCommTask const&) = delete;
private:
//////////////////////////////////////////////////////////////////////////////
/// @brief read block size
//////////////////////////////////////////////////////////////////////////////
static size_t const READ_BLOCK_SIZE = 10000;
public:
//////////////////////////////////////////////////////////////////////////////
/// @brief constructs a new task with a given socket
//////////////////////////////////////////////////////////////////////////////
HttpsCommTask(GeneralServer*, TRI_socket_t, ConnectionInfo&&,
double keepAliveTimeout, SSL_CTX* ctx, int verificationMode,
int (*verificationCallback)(int, X509_STORE_CTX*));
//////////////////////////////////////////////////////////////////////////////
/// @brief destructs a task
//////////////////////////////////////////////////////////////////////////////
protected:
~HttpsCommTask();
protected:
bool setup(Scheduler*, EventLoop) override;
bool handleEvent(EventToken, EventType) override;
bool fillReadBuffer() override;
bool handleWrite() override;
private:
//////////////////////////////////////////////////////////////////////////////
/// @brief accepts SSL connection
//////////////////////////////////////////////////////////////////////////////
bool trySSLAccept();
//////////////////////////////////////////////////////////////////////////////
/// @brief reads from SSL connection
//////////////////////////////////////////////////////////////////////////////
bool trySSLRead();
//////////////////////////////////////////////////////////////////////////////
/// @brief writes from SSL connection
//////////////////////////////////////////////////////////////////////////////
bool trySSLWrite();
//////////////////////////////////////////////////////////////////////////////
/// @brief shuts down the SSL connection
//////////////////////////////////////////////////////////////////////////////
void shutdownSsl(bool initShutdown);
private:
//////////////////////////////////////////////////////////////////////////////
/// @brief accepted done
//////////////////////////////////////////////////////////////////////////////
bool _accepted;
//////////////////////////////////////////////////////////////////////////////
/// @brief read blocked on write
//////////////////////////////////////////////////////////////////////////////
bool _readBlockedOnWrite;
//////////////////////////////////////////////////////////////////////////////
/// @brief write blocked on read
//////////////////////////////////////////////////////////////////////////////
bool _writeBlockedOnRead;
//////////////////////////////////////////////////////////////////////////////
/// @brief temporary buffer
//////////////////////////////////////////////////////////////////////////////
char* _tmpReadBuffer;
//////////////////////////////////////////////////////////////////////////////
/// @brief ssl
//////////////////////////////////////////////////////////////////////////////
SSL* _ssl;
//////////////////////////////////////////////////////////////////////////////
/// @brief context
//////////////////////////////////////////////////////////////////////////////
SSL_CTX* _ctx;
//////////////////////////////////////////////////////////////////////////////
/// @brief verification mode
//////////////////////////////////////////////////////////////////////////////
int _verificationMode;
//////////////////////////////////////////////////////////////////////////////
/// @brief verification callback
//////////////////////////////////////////////////////////////////////////////
int (*_verificationCallback)(int, X509_STORE_CTX*);
};
}
}
} // rest
} // arango
#endif

View File

View File

View File

View File