-
Notifications
You must be signed in to change notification settings - Fork 192
Expand file tree
/
Copy pathhttp_request.hpp
More file actions
533 lines (450 loc) · 18.2 KB
/
http_request.hpp
File metadata and controls
533 lines (450 loc) · 18.2 KB
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
/*
This file is part of libhttpserver
Copyright (C) 2011-2019 Sebastiano Merlino
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
*/
#if !defined (_HTTPSERVER_HPP_INSIDE_) && !defined (HTTPSERVER_COMPILATION)
#error "Only <httpserver.hpp> or <httpserverpp> can be included directly."
#endif
#ifndef SRC_HTTPSERVER_HTTP_REQUEST_HPP_
#define SRC_HTTPSERVER_HTTP_REQUEST_HPP_
#include <microhttpd.h>
#ifdef HAVE_GNUTLS
#include <gnutls/gnutls.h>
#endif // HAVE_GNUTLS
#include <stddef.h>
#include <algorithm>
#include <array>
#include <iosfwd>
#include <limits>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "httpserver/http_arg_value.hpp"
#include "httpserver/http_utils.hpp"
#include "httpserver/file_info.hpp"
#include "httpserver/create_webserver.hpp"
struct MHD_Connection;
namespace httpserver {
namespace details { struct modded_request; }
/**
* Class representing an abstraction for an Http Request. It is used from classes using these apis to receive information through http protocol.
**/
class http_request {
public:
static const char EMPTY[];
#ifdef HAVE_BAUTH
/**
* Method used to get the username eventually passed through basic authentication.
* @return string representation of the username.
**/
std::string_view get_user() const;
#endif // HAVE_BAUTH
#ifdef HAVE_DAUTH
/**
* Method used to get the username extracted from a digest authentication
* @return the username
**/
std::string_view get_digested_user() const;
#endif // HAVE_DAUTH
#ifdef HAVE_BAUTH
/**
* Method used to get the password eventually passed through basic authentication.
* @return string representation of the password.
**/
std::string_view get_pass() const;
#endif // HAVE_BAUTH
/**
* Method used to get the path requested
* @return string representing the path requested.
**/
std::string_view get_path() const {
return path;
}
/**
* Method used to get all pieces of the path requested; considering an url splitted by '/'.
* @return a vector of strings containing all pieces
**/
const std::vector<std::string> get_path_pieces() const {
ensure_path_pieces_cached();
return cache->path_pieces;
}
/**
* Method used to obtain a specified piece of the path; considering an url splitted by '/'.
* @param index the index of the piece selected
* @return the selected piece in form of string
**/
const std::string get_path_piece(int index) const {
ensure_path_pieces_cached();
if (static_cast<int>(cache->path_pieces.size()) > index) {
return cache->path_pieces[index];
}
return EMPTY;
}
/**
* Method used to get the METHOD used to make the request.
* @return string representing the method.
**/
std::string_view get_method() const {
return method;
}
/**
* Method used to get all headers passed with the request.
* @param result a map<string, string> > that will be filled with all headers
* @result the size of the map
**/
const http::header_view_map get_headers() const;
/**
* Method used to get all footers passed with the request.
* @param result a map<string, string> > that will be filled with all footers
* @result the size of the map
**/
const http::header_view_map get_footers() const;
/**
* Method used to get all cookies passed with the request.
* @param result a map<string, string> > that will be filled with all cookies
* @result the size of the map
**/
const http::header_view_map get_cookies() const;
/**
* Method used to get all args passed with the request.
* @result the size of the map
**/
const http::arg_view_map get_args() const;
/**
* Method used to get all args passed with the request. If any key has multiple
* values, one value is chosen and returned.
* @result the size of the map
**/
const std::map<std::string_view, std::string_view, http::arg_comparator> get_args_flat() const;
/**
* Method to get or create a file info struct in the map if the provided filename is already in the map
* return the exiting file info struct, otherwise create one in the map and return it.
* @param upload_file_name the file name the user uploaded (this is the identifier for the map entry)
* @result a http::file_info
**/
http::file_info& get_or_create_file_info(const std::string& key, const std::string& upload_file_name);
/**
* Method used to get all files passed with the request.
* @result result a map<std::string, map<std::string, http::file_info> > that will be filled with all files
**/
const std::map<std::string, std::map<std::string, http::file_info>> get_files() const {
return files;
}
/**
* Method used to get a specific header passed with the request.
* @param key the specific header to get the value from
* @return the value of the header.
**/
std::string_view get_header(std::string_view key) const;
std::string_view get_cookie(std::string_view key) const;
/**
* Method used to get a specific footer passed with the request.
* @param key the specific footer to get the value from
* @return the value of the footer.
**/
std::string_view get_footer(std::string_view key) const;
/**
* Method used to get a specific argument passed with the request.
* @param key the specific argument to get the value from
* @return the value(s) of the arg.
**/
http_arg_value get_arg(std::string_view key) const;
/**
* Method used to get a specific argument passed with the request.
* If the arg key has more than one value, only one is returned.
* @param key the specific argument to get the value from
* @return the value of the arg.
**/
std::string_view get_arg_flat(std::string_view key) const;
/**
* Method used to get the content of the request.
* @return the content in string representation
**/
std::string_view get_content() const {
return content;
}
/**
* Method to check whether the size of the content reached or exceeded content_size_limit.
* @return boolean
**/
bool content_too_large() const {
return content.size() >= content_size_limit;
}
/**
* Method used to get the content of the query string..
* @return the query string in string representation
**/
std::string_view get_querystring() const;
/**
* Method used to get the version of the request.
* @return the version in string representation
**/
std::string_view get_version() const {
return version;
}
#ifdef HAVE_GNUTLS
/**
* Method used to check if there is a TLS session.
* @return the TLS session
**/
bool has_tls_session() const;
/**
* Method used to get the TLS session.
* @return the TLS session
**/
gnutls_session_t get_tls_session() const;
/**
* Check if a client certificate is present in the TLS session.
* @return true if client certificate is present
**/
bool has_client_certificate() const;
/**
* Get the Subject Distinguished Name from the client certificate.
* @return the subject DN as a string, empty if not available
**/
std::string get_client_cert_dn() const;
/**
* Get the Issuer Distinguished Name from the client certificate.
* @return the issuer DN as a string, empty if not available
**/
std::string get_client_cert_issuer_dn() const;
/**
* Get the Common Name (CN) from the client certificate subject.
* @return the CN as a string, empty if not available
**/
std::string get_client_cert_cn() const;
/**
* Check if the client certificate chain has been verified.
* @return true if certificate verification passed
**/
bool is_client_cert_verified() const;
/**
* Get the SHA-256 fingerprint of the client certificate.
* @return hex-encoded SHA-256 fingerprint, empty if not available
**/
std::string get_client_cert_fingerprint_sha256() const;
/**
* Get the not-before (validity start) time of the client certificate.
* @return validity start time as time_t, -1 if not available
**/
time_t get_client_cert_not_before() const;
/**
* Get the not-after (validity end) time of the client certificate.
* @return validity end time as time_t, -1 if not available
**/
time_t get_client_cert_not_after() const;
#endif // HAVE_GNUTLS
/**
* Method used to get the requestor.
* @return the requestor
**/
std::string_view get_requestor() const;
/**
* Method used to get the requestor port used.
* @return the requestor port
**/
uint16_t get_requestor_port() const;
#ifdef HAVE_DAUTH
bool check_digest_auth(const std::string& realm, const std::string& password, int nonce_timeout, bool* reload_nonce) const;
/**
* Check digest authentication using a pre-computed HA1 hash.
* The HA1 hash is computed as: hash(username:realm:password) using the specified algorithm.
* @param realm The authentication realm.
* @param digest Pointer to the pre-computed HA1 hash bytes.
* @param digest_size Size of the digest (16 for MD5, 32 for SHA-256).
* @param nonce_timeout Nonce validity timeout in seconds.
* @param reload_nonce Output: set to true if nonce should be regenerated.
* @param algo The digest algorithm (defaults to MD5).
* @return true if authenticated, false otherwise.
*/
bool check_digest_auth_ha1(
const std::string& realm,
const unsigned char* digest,
size_t digest_size,
int nonce_timeout,
bool* reload_nonce,
http::http_utils::digest_algorithm algo = http::http_utils::digest_algorithm::MD5) const;
#endif // HAVE_DAUTH
friend std::ostream &operator<< (std::ostream &os, http_request &r);
~http_request();
private:
/**
* Default constructor of the class. It is a specific responsibility of apis to initialize this type of objects.
**/
http_request() = default;
http_request(MHD_Connection* underlying_connection, unescaper_ptr unescaper):
underlying_connection(underlying_connection),
unescaper(unescaper) {}
/**
* Copy constructor. Deleted to make class move-only. The class is move-only for several reasons:
* - Internal cache structure is expensive to copy
* - Various string members are expensive to copy
* - The destructor removes transient files from disk, which must only happen once.
* - unique_ptr members are not copyable.
**/
http_request(const http_request& b) = delete;
/**
* Move constructor.
* @param b http_request b to move attributes from.
**/
http_request(http_request&& b) noexcept = default;
/**
* Copy-assign. Deleted to make class move-only. The class is move-only for several reasons:
* - Internal cache structure is expensive to copy
* - Various string members are expensive to copy
* - The destructor removes transient files from disk, which must only happen once.
* - unique_ptr members are not copyable.
**/
http_request& operator=(const http_request& b) = delete;
http_request& operator=(http_request&& b) = default;
std::string path;
std::string method;
std::map<std::string, std::map<std::string, http::file_info>> files;
std::string content = "";
size_t content_size_limit = std::numeric_limits<size_t>::max();
std::string version;
struct MHD_Connection* underlying_connection = nullptr;
unescaper_ptr unescaper = nullptr;
static MHD_Result build_request_header(void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
static MHD_Result build_request_args(void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
static MHD_Result build_request_querystring(void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
#ifdef HAVE_BAUTH
void fetch_user_pass() const;
#endif // HAVE_BAUTH
/**
* Method used to set an argument value by key.
* @param key The name identifying the argument
* @param value The value assumed by the argument
**/
void set_arg(const std::string& key, const std::string& value) {
cache->unescaped_args[key].push_back(value.substr(0, content_size_limit));
}
/**
* Method used to set an argument value by key.
* @param key The name identifying the argument
* @param value The value assumed by the argument
* @param size The size in number of char of the value parameter.
**/
void set_arg(const char* key, const char* value, size_t size) {
cache->unescaped_args[key].push_back(std::string(value, std::min(size, content_size_limit)));
}
/**
* Method used to set an argument value by key. If a key already exists, overwrites it.
* @param key The name identifying the argument
* @param value The value assumed by the argument
**/
void set_arg_flat(const std::string& key, const std::string& value) {
cache->unescaped_args[key] = { (value.substr(0, content_size_limit)) };
}
void grow_last_arg(const std::string& key, const std::string& value);
/**
* Method used to set the content of the request
* @param content The content to set.
**/
void set_content(const std::string& content) {
this->content = content.substr(0, content_size_limit);
}
/**
* Method used to set the maximum size of the content
* @param content_size_limit The limit on the maximum size of the content and arg's.
**/
void set_content_size_limit(size_t content_size_limit) {
this->content_size_limit = content_size_limit;
}
/**
* Method used to append content to the request preserving the previous inserted content
* @param content The content to append.
* @param size The size of the data to append.
**/
void grow_content(const char* content, size_t size) {
this->content.append(content, size);
if (this->content.size() > content_size_limit) {
this->content.resize(content_size_limit);
}
}
/**
* Method used to set the path requested.
* @param path The path searched by the request.
**/
void set_path(const std::string& path) {
this->path = path;
}
/**
* Method used to set the request METHOD
* @param method The method to set for the request
**/
void set_method(const std::string& method);
/**
* Method used to set the request http version (ie http 1.1)
* @param version The version to set in form of string
**/
void set_version(const std::string& version) {
this->version = version;
}
/**
* Method used to set all arguments of the request.
* @param args The args key-value map to set for the request.
**/
void set_args(const std::map<std::string, std::string>& args) {
for (auto const& [key, value] : args) {
cache->unescaped_args[key].push_back(value.substr(0, content_size_limit));
}
}
std::string_view get_connection_value(std::string_view key, enum MHD_ValueKind kind) const;
const http::header_view_map get_headerlike_values(enum MHD_ValueKind kind) const;
// http_request objects are owned by a single connection and are not
// shared across threads. Lazy caching (path_pieces, args, etc.) is
// safe without synchronization under this invariant.
// Cache certain data items on demand so we can consistently return views
// over the data. Some things we transform before returning to the user for
// simplicity (e.g. query_str, requestor), others out of necessity (arg unescaping).
// Others (username, password, digested_user) MHD returns as char* that we need
// to make a copy of and free anyway.
struct http_request_data_cache {
#ifdef HAVE_BAUTH
std::string username;
std::string password;
#endif // HAVE_BAUTH
std::string querystring;
std::string requestor_ip;
#ifdef HAVE_DAUTH
std::string digested_user;
#endif // HAVE_DAUTH
std::map<std::string, std::vector<std::string>, http::arg_comparator> unescaped_args;
std::vector<std::string> path_pieces;
bool args_populated = false;
bool path_pieces_cached = false;
};
std::unique_ptr<http_request_data_cache> cache = std::make_unique<http_request_data_cache>();
void ensure_path_pieces_cached() const {
if (!cache->path_pieces_cached) {
cache->path_pieces = http::http_utils::tokenize_url(path);
cache->path_pieces_cached = true;
}
}
// Populate the data cache unescaped_args
void populate_args() const;
file_cleanup_callback_ptr file_cleanup_callback = nullptr;
void set_file_cleanup_callback(file_cleanup_callback_ptr callback) {
file_cleanup_callback = callback;
}
friend class webserver;
friend struct details::modded_request;
};
std::ostream &operator<< (std::ostream &os, const http_request &r);
} // namespace httpserver
#endif // SRC_HTTPSERVER_HTTP_REQUEST_HPP_