1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
|
/*
Copyright (©) 2003-2025 Teus Benschop.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <webserver/http.h>
#include <filter/url.h>
#include <config/globals.h>
#include <filter/string.h>
#include <webserver/request.h>
#include <database/logs.h>
static void http_parse_post_multipart (std::string content, Webserver_Request& webserver_request);
static void http_parse_post_standard (std::string content, Webserver_Request& webserver_request);
static std::vector<std::pair<std::string,std::string>> parse_application_x_www_form_urlencoded(const std::string& post);
static std::vector<std::pair<std::string,std::string>> parse_text_plain(const std::string& post);
static void parse_multipart_form_data(std::string post, std::vector<std::pair<std::string,std::string>>& result);
static void remove_cr_lf_at_start(std::string& post);
static void remove_cr_lf_at_end(std::string& post);
// The http headers from a browser could look as follows:
//
// GET /index/page HTTP/1.1
// Host: localhost:8080
// Connection: keep-alive
// User-Agent: Mozilla/n.0 (X11; Linux x86_64) AppleWebKit/nnn.nn (KHTML, like Gecko) Chrome/3nn.n.nnnn.nnn Safari/nnn.nn
// Accept-Language: sn,en-US;q=0.8,en;q=0.6
// Cookie: Session=abcdefghijklmnopqrstuvwxyz; foo=bar; extra=clutter
//
// The function extracts the relevant information from one line of the headers.
//
// It returns true if a header was (or could have been) parsed.
bool http_parse_header (std::string header, Webserver_Request& webserver_request)
{
// Clean the header line.
header = filter::strings::trim(std::move(header));
// Deal with a header like this: GET /css/stylesheet.css?1.0.1 HTTP/1.1
// Or like this: POST /session/login?request= HTTP/1.1
bool is_get_request { false };
if (header.substr (0, 3) == "GET") is_get_request = true;
if (header.substr (0, 4) == "POST") {
is_get_request = true;
webserver_request.is_post = true;
}
if (is_get_request) {
std::string query_data{};
const std::vector<std::string> get = filter::strings::explode(header, ' ');
if (get.size() >= 2) {
webserver_request.get = get.at(1);
// The GET or POST value may be, for example: stylesheet.css?1.0.1.
// Split it up into two parts: The part before the ?, and the part after the ?.
std::istringstream issquery (webserver_request.get);
int counter {0};
std::string s{};
while (getline (issquery, s, '?')) {
if (counter == 0) webserver_request.get = s;
if (counter == 1) query_data = s;
counter++;
}
}
// Read and parse the GET data.
try {
if (!query_data.empty ()) {
// Example input data: key1=value1&key2=value2#fragment
// Remove the optional fragment.
// Explode the data on the ampersand ( & ) and then on the equal sign ( = ).
if (const size_t pos = query_data.find("#"); pos != std::string::npos) {
query_data.erase(pos);
}
std::vector<std::string> keys_values = filter::strings::explode(std::move(query_data), '&');
for (const auto& fragment : keys_values) {
std::vector<std::string> key_value = filter::strings::explode(fragment, '=');
// Handle situation that only the key is given.
if (key_value.size() == 1)
webserver_request.query[key_value.at(0)] = std::string();
// Handle normal situation: Both key and value are given.
if (key_value.size() == 2)
webserver_request.query[key_value.at(0)] = filter_url_urldecode(key_value.at(1));
}
}
} catch (...) {
}
}
// Extract the User-Agent from a header like this:
// User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/38.0.2125.104 Safari/537.36
if (header.substr (0, 10) == "User-Agent") {
webserver_request.user_agent = header.substr (12);
}
// Extract the Accept-Language from a header like this:
// Accept-Language: sn,en-US;q=0.8,en;q=0.6
if (header.substr (0, 15) == "Accept-Language") {
webserver_request.accept_language = header.substr (17);
}
// Extract the host from headers like this:
// Host: 192.168.1.139:8080
// Host: [::1]:8080
// Host: localhost:8080
// Host: <empty>
if (header.substr (0, 4) == "Host") {
if (header.size () >= 6) {
webserver_request.host = http_parse_host (header.substr (6));
}
}
// Extract the Content-Type from a header like this:
// Content-Type: application/x-www-form-urlencoded
if (header.substr (0, 12) == "Content-Type") {
webserver_request.content_type = header.substr (14);
}
// Extract the Content-Length from a header.
if (header.substr (0, 14) == "Content-Length") {
webserver_request.content_length = filter::strings::convert_to_int (header.substr (16));
}
// Extract the ETag from a header.
if (header.substr (0, 13) == "If-None-Match") {
webserver_request.if_none_match = header.substr (15);
}
// Extract the relevant cookie.
// When the browser has more than one cookies, it sends them all, e.g.:
// Cookie: Session=abcdefghijklmnopqrstuvwxyz; foo=bar; extra=clutter
// Bibledit is only interested in the "Session" one.
if (header.substr (0, 6) == "Cookie") {
std::string cookie_data = header.substr (8);
size_t pos = cookie_data.find ("Session=");
if (pos != std::string::npos) {
cookie_data.erase (0, pos + 8);
pos = cookie_data.find (";");
if (pos != std::string::npos) {
cookie_data.erase (pos);
}
}
webserver_request.session_identifier = cookie_data;
}
// Something was or could have been parsed if the header contained something.
return !header.empty ();
}
// Takes data POSTed from the browser, and parses it.
void http_parse_post (std::string content, Webserver_Request& webserver_request)
{
// If there's no content, there's nothing to parse: Done.
if (content.empty ())
return;
// Parse multipart data in a special way, and other data in the standard way.
const bool multipart = webserver_request.content_type.find ("multipart") != std::string::npos;
if (multipart) {
http_parse_post_multipart (std::move(content), webserver_request);
} else {
http_parse_post_standard (std::move(content), webserver_request);
}
}
/*
The function assembles the response to be given to the browser.
code: an integer response code, normally this is 200.
header: An extra header to be sent with the response. May be empty.
contents: the response body to be sent.
The function inserts the correct headers,
and creates the entire result to be sent back to the browser.
*/
void http_assemble_response (Webserver_Request& webserver_request)
{
std::ostringstream length{};
if (webserver_request.stream_file.empty()) {
// Serving data: Take the length from the size of the reply.
length << webserver_request.reply.size ();
} else {
// Streaming a file: Take the file size as the length.
length << filter_url_filesize (webserver_request.stream_file);
}
// Assemble the HTTP response code fragment.
const std::string http_response_code_fragment = filter_url_http_response_code_text (webserver_request.response_code);
// Assemble the Content-Type.
std::string extension = filter_url_get_extension (webserver_request.get);
extension = filter::strings::unicode_string_casefold (extension);
std::string content_type = filter_url_get_mime_type (extension);
if (extension == "usfm") content_type = "text/plain";
if (extension.empty()) content_type = "text/html";
if (extension == "sh") content_type = "application/octet-stream";
if (extension == "sqlite") content_type = "application/octet-stream";
if (extension == "download") content_type = "application/octet-stream";
// If still empty, take the default binary content type.
if (content_type.empty()) content_type = "application/octet-stream";
// If already defined, take that.
if (!webserver_request.response_content_type.empty ()) content_type = webserver_request.response_content_type;
// Assemble the complete response for the browser.
std::vector <std::string> response{};
response.push_back ("HTTP/1.1 " + http_response_code_fragment);
response.push_back ("Accept-Ranges: bytes");
response.push_back ("Content-Length: " + length.str());
response.push_back ("Content-Type: " + content_type);
if (!webserver_request.etag.empty ()) {
response.push_back ("Cache-Control: max-age=120");
response.push_back ("ETag: " + webserver_request.etag);
}
if (webserver_request.session_identifier.empty () || webserver_request.resend_cookie) {
// If the browser did not send a cookie to the server, the server sends a new one to the browser.
// Once a day, it resends the existing one, to refresh it in the browser.
// The cookie consists of the following components:
// * Name
// * Value
// * Zero or more attributes
// Create a new identifier, and stores it in the cookie as name "Session".
// The identifier is a long string of random letters and numbers.
// The Path is given as / because typically the client connects to e.g. bibledit.org:8080/.
// It would be good if the port number can be used with cookies also,
// but it can't, see https://tools.ietf.org/html/rfc6265.
// The Max-Age attribute is used to set the cookie’s expiration
// as an interval of seconds in the future,
// relative to the time the browser received the cookie.
// If the expiry information were omitted from the cookie, closing the browser would remove the cookie.
// The Secure attribute is set.
// It is meant to keep cookie communication limited to encrypted transmission,
// directing browsers to use cookies only via secure/encrypted connections.
// Cookies with the Secure attribute should only be set over a secure connection.
// If the Secure attribute is set and the connection is over http,
// then the browser indicates:
// This attempt to set a cookie via a Set-Cookie header was blocked
// because it had the "Secure" attribute but was not received over a secure connection.
// The result of this is that a user cannot login to Bibledit Cloud over a plain connection.
// The localhost binding works because most browsers have special-case code
// to treat connections to that host name as "secure", even if they don't use HTTPS.
// The HttpOnly attribute means that the cookie can be accessed by the HTTP API only,
// and not by for example Javascript running in the browser.
// This provides extra security.
// The setting "SameSite" is set to "None" to enable cookies while embedded in e.g. NextCloud,
// which works via an iframe on a different origin.
// If set to "None", this only works on a secure connection.
// On a plain connection, the browser says:
// This attempt to set a cookie via a Set-Cookie header was blocked
// because it had the "SameSite=None" attribute but did not have the "Secure" attribute,
// which is required in order to use "SameSite=None".
// If a user het logged into Bibledit via https,
// and then next logs in via http, a plain connection,
// then login fails.
// The browser says this:
// This attempt to set a cookie via a Set-Cookie header was blocked
// because it was not sent over a secure connection
// and would have overwritten a cookie with the Secure attribute.
std::string identifier = webserver_request.session_identifier;
if (identifier.empty ())
identifier = filter::strings::get_new_random_string ();
std::string cookie = "Session=" + identifier + "; Path=/; Max-Age=2678400; HttpOnly";
if (webserver_request.secure)
cookie.append("; SameSite=None; Secure");
response.push_back ("Set-Cookie: " + cookie);
}
if (!webserver_request.header.empty ())
response.push_back (webserver_request.header);
response.push_back (std::string());
if (webserver_request.stream_file.empty()) {
// Serving data: Add the data from the "reply" property.
response.push_back (webserver_request.reply);
} else {
// Streaming a file: Add empty string.
// This triggers adding the new line between headers and body.
response.push_back (std::string());
}
std::string assembly{};
for (unsigned int i = 0; i < response.size (); i++) {
if (i > 0) assembly += "\n";
assembly += response [i];
}
webserver_request.reply = assembly;
}
// This function serves a file and enables caching by the browser.
// It enables streaming the file straight from disk to the network connection,
// without loading it in memory first.
// By doing so, it uses little memory, independent from the size of the file it serves.
// $enable_cache: Whether to enable caching by the browser.
void http_stream_file (Webserver_Request& webserver_request, bool enable_cache)
{
// Full path to the file.
const std::string url = filter_url_urldecode (webserver_request.get);
// The URL likely starts with a slash, like this: /css/mouse.css
// When creating a path out of that, the path will become this: /css/mouse.css
// Such a path does not exist.
// The path that is wanted is something like this:
// /home/foo/bar/bibledit/css/mouse.css
// So remove that starting slash.
const std::string filename = filter_url_create_root_path ({url});
// File size for browser caching.
if (enable_cache) {
const int size = filter_url_filesize (filename);
webserver_request.etag = "\"" + std::to_string (size) + "\"";
}
// Deal with situation that the file in the browser's cache is up to date.
// https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching
if (enable_cache) {
if (webserver_request.etag == webserver_request.if_none_match) {
webserver_request.response_code = 304;
return;
}
}
// Store the file name as a flag for processing the streaming.
webserver_request.stream_file = filename;
}
// Obtain the host name from lines like this:
// 192.168.1.139:8080
// localhost:8080
// [::1]:8080
// [fe80::601:25ff:fe07:6801]:8080
std::string http_parse_host (const std::string& line)
{
std::string host{};
size_t ipv6_opener = line.find ("[");
size_t ipv6_closer = line.find ("]");
if ((ipv6_opener != std::string::npos) && (ipv6_closer != std::string::npos)) {
// Square brackets? That's IPv6.
host = line.substr (0, ++ipv6_closer);
} else {
// IPv4.
host = line;
size_t pos = line.find (":");
if (pos != std::string::npos) {
host = host.substr (0, pos);
}
}
return host;
}
// Parser for POSTed multipart data. It splits the multiple parts up, and then runs the standard parser.
static void http_parse_post_multipart (std::string content, Webserver_Request& webserver_request)
{
// Get the boundary string from the content type.
// Example content type:
// multipart/form-data; boundary=----WebKitFormBoundarye9wsWKTf5zcLAGUn
// The boundary, as used in the posted body, starts with two extra hyphens.
const std::string content_type {webserver_request.content_type};
constexpr std::string_view boundary_is {"boundary="};
size_t pos = content_type.find(boundary_is);
if (pos == std::string::npos)
return;
const std::string boundary = "--" + content_type.substr(pos + boundary_is.size());
// Iterate over the posted body while it's longer than the boundary.
while (content.size() > boundary.size()) {
// The first boundary is expected to be located at position 0.
// If it's not there, stop parsing right away.
pos = content.find(boundary);
if (pos)
return;
// Remove the first boundary plus any following carriage return or line feed after that boundary.
content.erase(0, boundary.size());
remove_cr_lf_at_start(content);
// Find the boundary following the posted data fragment.
pos = content.find(boundary);
if (pos == std::string::npos)
return;
// Parse this chunk of data and then remove it.
http_parse_post_standard (content.substr(0, pos), webserver_request);
content.erase(0, pos);
}
}
// Takes data POSTed from the browser, and parses it.
static void http_parse_post_standard (std::string content, Webserver_Request& webserver_request)
{
// Read and parse the POST data.
try {
if (webserver_request.content_type.find(application_x_www_form_urlencoded) != std::string::npos) {
webserver_request.post = parse_application_x_www_form_urlencoded(content);
return;
}
if (webserver_request.content_type == text_plain) {
webserver_request.post = parse_text_plain(content);
return;
}
if (webserver_request.content_type.find(multipart_form_data) != std::string::npos) {
parse_multipart_form_data(content, webserver_request.post);
return;
}
throw std::runtime_error("Cannot parse content type " + webserver_request.content_type);
}
catch (const std::exception& exception) {
Database_Logs::log("POST parsing error: " + std::string(exception.what()));
}
}
static std::vector<std::pair<std::string,std::string>> parse_application_x_www_form_urlencoded(const std::string& post)
{
// Example input data: key1=value1&key2=value2
std::vector<std::pair<std::string,std::string>> result;
// First explode the data on the ampersand ( & ).
const std::vector<std::string> keys_values = filter::strings::explode(post, '&');
// Next explode each fragment on the equal sign ( = ).
for (const auto& fragment : keys_values) {
const std::vector<std::string> key_value = filter::strings::explode(fragment, '=');
// Handle situation that only the key is given.
if (key_value.size() == 1)
result.emplace_back(key_value.at(0), std::string());
// Handle normal situation: Both key and value are given.
if (key_value.size() == 2)
result.emplace_back(key_value.at(0), filter_url_urldecode(key_value.at(1)));
}
return result;
}
static std::vector<std::pair<std::string,std::string>> parse_text_plain(const std::string& post)
{
// Example input data:
// key1=value1\r\n
// key2=value2\r\n
std::vector<std::pair<std::string,std::string>> result;
// First explode the data on the carriage return and line feed ( \r\n ).
std::vector<std::string> keys_values = filter::strings::explode(post, "\r\n");
for (auto & key_value : keys_values) {
key_value = filter::strings::replace ("\r", "", std::move(key_value));
key_value = filter::strings::replace ("\n", "", std::move(key_value));
}
// Next explode each fragment on the equal sign ( = ).
for (const auto& fragment : keys_values) {
std::vector<std::string> key_value = filter::strings::explode(fragment, '=');
// Handle situation that only the key is given.
if (key_value.size() == 1)
result.emplace_back(std::move(key_value.at(0)), std::string());
// Handle normal situation: Both key and value are given.
if (key_value.size() == 2)
result.emplace_back(std::move(key_value.at(0)), std::move(key_value.at(1)));
}
return result;
}
void parse_multipart_form_data(std::string post, std::vector<std::pair<std::string,std::string>>& result)
{
//const bool urlencoded = content_type.find ("urlencoded") != std::string::npos;
// The first line looks similar to this:
// Content-Disposition: form-data; name="data"; filename="file.txt"
// Remove it from the input data.
std::string content_disposition_line;
{
constexpr const std::string_view content_disposition {"Content-Disposition:"};
if (post.find(content_disposition) != 0)
throw std::runtime_error (std::string(content_disposition) + " not found right at the start of the POSTed data");
const size_t pos = post.find_first_of("\r\n");
content_disposition_line = post.substr(0, pos);
post.erase(0, pos);
remove_cr_lf_at_start(post);
}
// Special case: Extract the filename in case of a file upload.
{
constexpr const std::string_view filename_is {"filename="};
std::string line {content_disposition_line};
if (line.find (filename_is) != std::string::npos) {
const size_t pos = line.find (filename_is);
if (pos != std::string::npos) {
line = line.substr (pos + filename_is.size() + 1);
line = filter::strings::trim (line);
line.pop_back ();
result.emplace_back("filename", line);
}
}
}
// Standard case: Extract the name, that is the "key" of the posted data.
std::string name {content_disposition_line};
constexpr const std::string_view name_is {"name="};
if (const size_t pos1 = name.find (name_is); pos1 != std::string::npos) {
name.erase(0, pos1 + name_is.size());
if (const size_t pos2 = name.find(R"(")"); pos2 != std::string::npos) {
name.erase(0, pos2 + 1);
if (const size_t pos3 = name.find(R"(")"); pos3 != std::string::npos) {
name.erase(pos3);
}
}
}
// The next, now first, line looks similar to this:
// Content-Type: text/plain
// It may be there, it also may be omitted.
// Remove it from the input data if it's there.
std::string content_type_line;
{
constexpr const std::string_view content_type {"Content-Type:"};
if (post.find(content_type) == 0) {
if (const size_t pos1 = post.find_first_of("\r\n"); pos1 != std::string::npos) {
content_type_line = post.substr(0, pos1);
post.erase(0, pos1);
remove_cr_lf_at_start(post);
}
}
}
// Having removed the initial headers,
// now remove the cr and lf that is between those headers and the posted payload.
remove_cr_lf_at_start(post);
// The posted data ends with cr lf. Remove those two.
remove_cr_lf_at_end(post);
// Store the data.
result.emplace_back(name, post);
}
static void remove_cr_lf_at_start(std::string& post)
{
for (int i{0}; i < 2; i++) {
if (post.empty())
continue;
if (post.find_first_of("\r\n") == 0)
post.erase(0, 1);
}
}
static void remove_cr_lf_at_end(std::string& post)
{
for (int i{0}; i < 2; i++) {
if (post.empty())
continue;
if (const size_t pos = post.find_last_of("\r\n"); pos == post.size()-1)
post.erase(pos, 1);
}
}
|