392 lines
15 KiB
C++
392 lines
15 KiB
C++
/*
|
|
* Authored by Alex Hultman, 2018-2020.
|
|
* Intellectual property of third-party.
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef UWS_HTTPPARSER_H
|
|
#define UWS_HTTPPARSER_H
|
|
|
|
// todo: HttpParser is in need of a few clean-ups and refactorings
|
|
|
|
/* The HTTP parser is an independent module subject to unit testing / fuzz testing */
|
|
|
|
#include <string>
|
|
#include <cstring>
|
|
#include <algorithm>
|
|
#include "f2/function2.hpp"
|
|
|
|
#include "BloomFilter.h"
|
|
#include "ProxyParser.h"
|
|
#include "QueryParser.h"
|
|
|
|
namespace uWS {
|
|
|
|
/* We require at least this much post padding */
|
|
static const unsigned int MINIMUM_HTTP_POST_PADDING = 32;
|
|
|
|
struct HttpRequest {
|
|
|
|
friend struct HttpParser;
|
|
|
|
private:
|
|
const static int MAX_HEADERS = 50;
|
|
struct Header {
|
|
std::string_view key, value;
|
|
} headers[MAX_HEADERS];
|
|
bool ancientHttp;
|
|
unsigned int querySeparator;
|
|
bool didYield;
|
|
BloomFilter bf;
|
|
std::pair<int, std::string_view *> currentParameters;
|
|
|
|
public:
|
|
bool isAncient() {
|
|
return ancientHttp;
|
|
}
|
|
|
|
bool getYield() {
|
|
return didYield;
|
|
}
|
|
|
|
/* Iteration over headers (key, value) */
|
|
struct HeaderIterator {
|
|
Header *ptr;
|
|
|
|
bool operator!=(const HeaderIterator &other) const {
|
|
/* Comparison with end is a special case */
|
|
if (ptr != other.ptr) {
|
|
return other.ptr || ptr->key.length();
|
|
}
|
|
return false;
|
|
}
|
|
|
|
HeaderIterator &operator++() {
|
|
ptr++;
|
|
return *this;
|
|
}
|
|
|
|
std::pair<std::string_view, std::string_view> operator*() const {
|
|
return {ptr->key, ptr->value};
|
|
}
|
|
};
|
|
|
|
HeaderIterator begin() {
|
|
return {headers + 1};
|
|
}
|
|
|
|
HeaderIterator end() {
|
|
return {nullptr};
|
|
}
|
|
|
|
/* If you do not want to handle this route */
|
|
void setYield(bool yield) {
|
|
didYield = yield;
|
|
}
|
|
|
|
std::string_view getHeader(std::string_view lowerCasedHeader) {
|
|
if (bf.mightHave(lowerCasedHeader)) {
|
|
for (Header *h = headers; (++h)->key.length(); ) {
|
|
if (h->key.length() == lowerCasedHeader.length() && !strncmp(h->key.data(), lowerCasedHeader.data(), lowerCasedHeader.length())) {
|
|
return h->value;
|
|
}
|
|
}
|
|
}
|
|
return std::string_view(nullptr, 0);
|
|
}
|
|
|
|
std::string_view getUrl() {
|
|
return std::string_view(headers->value.data(), querySeparator);
|
|
}
|
|
|
|
std::string_view getMethod() {
|
|
return std::string_view(headers->key.data(), headers->key.length());
|
|
}
|
|
|
|
/* Returns the raw querystring as a whole, still encoded */
|
|
std::string_view getQuery() {
|
|
if (querySeparator < headers->value.length()) {
|
|
/* Strip the initial ? */
|
|
return std::string_view(headers->value.data() + querySeparator + 1, headers->value.length() - querySeparator - 1);
|
|
} else {
|
|
return std::string_view(nullptr, 0);
|
|
}
|
|
}
|
|
|
|
/* Finds and decodes the URI component. */
|
|
std::string_view getQuery(std::string_view key) {
|
|
/* Raw querystring including initial '?' sign */
|
|
std::string_view queryString = std::string_view(headers->value.data() + querySeparator, headers->value.length() - querySeparator);
|
|
|
|
return getDecodedQueryValue(key, queryString);
|
|
}
|
|
|
|
void setParameters(std::pair<int, std::string_view *> parameters) {
|
|
currentParameters = parameters;
|
|
}
|
|
|
|
std::string_view getParameter(unsigned int index) {
|
|
if (currentParameters.first < (int) index) {
|
|
return {};
|
|
} else {
|
|
return currentParameters.second[index];
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
struct HttpParser {
|
|
|
|
private:
|
|
std::string fallback;
|
|
unsigned int remainingStreamingBytes = 0;
|
|
|
|
const size_t MAX_FALLBACK_SIZE = 1024 * 4;
|
|
|
|
static unsigned int toUnsignedInteger(std::string_view str) {
|
|
unsigned int unsignedIntegerValue = 0;
|
|
for (char c : str) {
|
|
unsignedIntegerValue = unsignedIntegerValue * 10u + ((unsigned int) c - (unsigned int) '0');
|
|
}
|
|
return unsignedIntegerValue;
|
|
}
|
|
|
|
static unsigned int getHeaders(char *postPaddedBuffer, char *end, struct HttpRequest::Header *headers, void *reserved) {
|
|
char *preliminaryKey, *preliminaryValue, *start = postPaddedBuffer;
|
|
|
|
#ifdef UWS_WITH_PROXY
|
|
/* ProxyParser is passed as reserved parameter */
|
|
ProxyParser *pp = (ProxyParser *) reserved;
|
|
|
|
/* Parse PROXY protocol */
|
|
auto [done, offset] = pp->parse({start, (size_t) (end - postPaddedBuffer)});
|
|
if (!done) {
|
|
/* We do not reset the ProxyParser (on filure) since it is tied to this
|
|
* connection, which is really only supposed to ever get one PROXY frame
|
|
* anyways. We do however allow multiple PROXY frames to be sent (overwrites former). */
|
|
return 0;
|
|
} else {
|
|
/* We have consumed this data so skip it */
|
|
start += offset;
|
|
}
|
|
#else
|
|
/* This one is unused */
|
|
(void) reserved;
|
|
#endif
|
|
|
|
/* It is critical for fallback buffering logic that we only return with success
|
|
* if we managed to parse a complete HTTP request (minus data). Returning success
|
|
* for PROXY means we can end up succeeding, yet leaving bytes in the fallback buffer
|
|
* which is then removed, and our counters to flip due to overflow and we end up with a crash */
|
|
|
|
for (unsigned int i = 0; i < HttpRequest::MAX_HEADERS; i++) {
|
|
for (preliminaryKey = postPaddedBuffer; (*postPaddedBuffer != ':') & (*postPaddedBuffer > 32); *(postPaddedBuffer++) |= 32);
|
|
if (*postPaddedBuffer == '\r') {
|
|
if ((postPaddedBuffer != end) & (postPaddedBuffer[1] == '\n') & (i > 0)) {
|
|
headers->key = std::string_view(nullptr, 0);
|
|
return (unsigned int) ((postPaddedBuffer + 2) - start);
|
|
} else {
|
|
return 0;
|
|
}
|
|
} else {
|
|
headers->key = std::string_view(preliminaryKey, (size_t) (postPaddedBuffer - preliminaryKey));
|
|
for (postPaddedBuffer++; (*postPaddedBuffer == ':' || *postPaddedBuffer < 33) && *postPaddedBuffer != '\r'; postPaddedBuffer++);
|
|
preliminaryValue = postPaddedBuffer;
|
|
postPaddedBuffer = (char *) memchr(postPaddedBuffer, '\r', (size_t) (end - postPaddedBuffer));
|
|
if (postPaddedBuffer && postPaddedBuffer[1] == '\n') {
|
|
headers->value = std::string_view(preliminaryValue, (size_t) (postPaddedBuffer - preliminaryValue));
|
|
postPaddedBuffer += 2;
|
|
headers++;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
// the only caller of getHeaders
|
|
template <int CONSUME_MINIMALLY>
|
|
std::pair<unsigned int, void *> fenceAndConsumePostPadded(char *data, unsigned int length, void *user, void *reserved, HttpRequest *req, fu2::unique_function<void *(void *, HttpRequest *)> &requestHandler, fu2::unique_function<void *(void *, std::string_view, bool)> &dataHandler) {
|
|
|
|
/* How much data we CONSUMED (to throw away) */
|
|
unsigned int consumedTotal = 0;
|
|
|
|
/* Fence one byte past end of our buffer (buffer has post padded margins) */
|
|
data[length] = '\r';
|
|
|
|
for (unsigned int consumed; length && (consumed = getHeaders(data, data + length, req->headers, reserved)); ) {
|
|
data += consumed;
|
|
length -= consumed;
|
|
consumedTotal += consumed;
|
|
|
|
/* Store HTTP version (ancient 1.0 or 1.1) */
|
|
req->ancientHttp = req->headers->value.length() && (req->headers->value[req->headers->value.length() - 1] == '0');
|
|
|
|
/* Strip away tail of first "header value" aka URL */
|
|
req->headers->value = std::string_view(req->headers->value.data(), (size_t) std::max<int>(0, (int) req->headers->value.length() - 9));
|
|
|
|
/* Add all headers to bloom filter */
|
|
req->bf.reset();
|
|
for (HttpRequest::Header *h = req->headers; (++h)->key.length(); ) {
|
|
req->bf.add(h->key);
|
|
}
|
|
|
|
/* Parse query */
|
|
const char *querySeparatorPtr = (const char *) memchr(req->headers->value.data(), '?', req->headers->value.length());
|
|
req->querySeparator = (unsigned int) ((querySeparatorPtr ? querySeparatorPtr : req->headers->value.data() + req->headers->value.length()) - req->headers->value.data());
|
|
|
|
/* If returned socket is not what we put in we need
|
|
* to break here as we either have upgraded to
|
|
* WebSockets or otherwise closed the socket. */
|
|
void *returnedUser = requestHandler(user, req);
|
|
if (returnedUser != user) {
|
|
/* We are upgraded to WebSocket or otherwise broken */
|
|
return {consumedTotal, returnedUser};
|
|
}
|
|
|
|
// todo: do not check this for GET (get should not have a body)
|
|
// todo: also support reading chunked streams
|
|
std::string_view contentLengthString = req->getHeader("content-length");
|
|
if (contentLengthString.length()) {
|
|
remainingStreamingBytes = toUnsignedInteger(contentLengthString);
|
|
|
|
if (!CONSUME_MINIMALLY) {
|
|
unsigned int emittable = std::min<unsigned int>(remainingStreamingBytes, length);
|
|
dataHandler(user, std::string_view(data, emittable), emittable == remainingStreamingBytes);
|
|
remainingStreamingBytes -= emittable;
|
|
|
|
data += emittable;
|
|
length -= emittable;
|
|
consumedTotal += emittable;
|
|
}
|
|
} else {
|
|
/* Still emit an empty data chunk to signal no data */
|
|
dataHandler(user, {}, true);
|
|
}
|
|
|
|
if (CONSUME_MINIMALLY) {
|
|
break;
|
|
}
|
|
}
|
|
return {consumedTotal, user};
|
|
}
|
|
|
|
public:
|
|
void *consumePostPadded(char *data, unsigned int length, void *user, void *reserved, fu2::unique_function<void *(void *, HttpRequest *)> &&requestHandler, fu2::unique_function<void *(void *, std::string_view, bool)> &&dataHandler, fu2::unique_function<void *(void *)> &&errorHandler) {
|
|
|
|
/* This resets BloomFilter by construction, but later we also reset it again.
|
|
* Optimize this to skip resetting twice (req could be made global) */
|
|
HttpRequest req;
|
|
|
|
if (remainingStreamingBytes) {
|
|
|
|
// this is exactly the same as below!
|
|
// todo: refactor this
|
|
if (remainingStreamingBytes >= length) {
|
|
void *returnedUser = dataHandler(user, std::string_view(data, length), remainingStreamingBytes == length);
|
|
remainingStreamingBytes -= length;
|
|
return returnedUser;
|
|
} else {
|
|
void *returnedUser = dataHandler(user, std::string_view(data, remainingStreamingBytes), true);
|
|
|
|
data += remainingStreamingBytes;
|
|
length -= remainingStreamingBytes;
|
|
|
|
remainingStreamingBytes = 0;
|
|
|
|
if (returnedUser != user) {
|
|
return returnedUser;
|
|
}
|
|
}
|
|
|
|
} else if (fallback.length()) {
|
|
unsigned int had = (unsigned int) fallback.length();
|
|
|
|
size_t maxCopyDistance = std::min(MAX_FALLBACK_SIZE - fallback.length(), (size_t) length);
|
|
|
|
/* We don't want fallback to be short string optimized, since we want to move it */
|
|
fallback.reserve(fallback.length() + maxCopyDistance + std::max<unsigned int>(MINIMUM_HTTP_POST_PADDING, sizeof(std::string)));
|
|
fallback.append(data, maxCopyDistance);
|
|
|
|
// break here on break
|
|
std::pair<unsigned int, void *> consumed = fenceAndConsumePostPadded<true>(fallback.data(), (unsigned int) fallback.length(), user, reserved, &req, requestHandler, dataHandler);
|
|
if (consumed.second != user) {
|
|
return consumed.second;
|
|
}
|
|
|
|
if (consumed.first) {
|
|
|
|
/* This logic assumes that we consumed everything in fallback buffer.
|
|
* This is critically important, as we will get an integer overflow in case
|
|
* of "had" being larger than what we consumed, and that we would drop data */
|
|
fallback.clear();
|
|
data += consumed.first - had;
|
|
length -= consumed.first - had;
|
|
|
|
if (remainingStreamingBytes) {
|
|
// this is exactly the same as above!
|
|
if (remainingStreamingBytes >= (unsigned int) length) {
|
|
void *returnedUser = dataHandler(user, std::string_view(data, length), remainingStreamingBytes == (unsigned int) length);
|
|
remainingStreamingBytes -= length;
|
|
return returnedUser;
|
|
} else {
|
|
void *returnedUser = dataHandler(user, std::string_view(data, remainingStreamingBytes), true);
|
|
|
|
data += remainingStreamingBytes;
|
|
length -= remainingStreamingBytes;
|
|
|
|
remainingStreamingBytes = 0;
|
|
|
|
if (returnedUser != user) {
|
|
return returnedUser;
|
|
}
|
|
}
|
|
}
|
|
|
|
} else {
|
|
if (fallback.length() == MAX_FALLBACK_SIZE) {
|
|
// note: you don't really need error handler, just return something strange!
|
|
// we could have it return a constant pointer to denote error!
|
|
return errorHandler(user);
|
|
}
|
|
return user;
|
|
}
|
|
}
|
|
|
|
std::pair<unsigned int, void *> consumed = fenceAndConsumePostPadded<false>(data, length, user, reserved, &req, requestHandler, dataHandler);
|
|
if (consumed.second != user) {
|
|
return consumed.second;
|
|
}
|
|
|
|
data += consumed.first;
|
|
length -= consumed.first;
|
|
|
|
if (length) {
|
|
if (length < MAX_FALLBACK_SIZE) {
|
|
fallback.append(data, length);
|
|
} else {
|
|
return errorHandler(user);
|
|
}
|
|
}
|
|
|
|
// added for now
|
|
return user;
|
|
}
|
|
};
|
|
|
|
}
|
|
|
|
#endif // UWS_HTTPPARSER_H
|