forked from etr/libhttpserver
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwebserver.hpp
More file actions
617 lines (568 loc) · 25.5 KB
/
webserver.hpp
File metadata and controls
617 lines (568 loc) · 25.5 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
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
/*
This file is part of libhttpserver
Copyright (C) 2011 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 _FRAMEWORK_WEBSERVER_HPP_
#define _FRAMEWORK_WEBSERVER_HPP_
#define NOT_FOUND_ERROR "Not Found"
#define METHOD_ERROR "Method not Allowed"
#define NOT_METHOD_ERROR "Method not Acceptable"
#define GENERIC_ERROR "Internal Error"
#define DEFAULT_WS_PORT 9898
#define DEFAULT_WS_TIMEOUT 180
#include <cstring>
#include <map>
#include <vector>
#ifdef USE_CPP_ZEROX
#include <unordered_set>
#else
#include <set>
#endif
#include <string>
#include <utility>
#include <memory>
#include <deque>
#include <pthread.h>
namespace httpserver {
class http_resource;
class http_response;
class cache_response;
class http_request;
class long_polling_receive_response;
class long_polling_send_response;
struct cache_entry;
namespace details
{
class http_endpoint;
struct modded_request;
struct cache_manager;
struct daemon_item;
void unlock_cache_entry(cache_entry*);
void lock_cache_entry(cache_entry*);
http_response* get_response(cache_entry*);
}
using namespace http;
namespace http {
struct ip_representation;
};
/**
* Delegate class used to wrap callbacks dedicated to logging.
**/
class logging_delegate
{
public:
/**
* Delegate constructor.
**/
logging_delegate();
/**
* Destructor of the class
**/
virtual ~logging_delegate();
/**
* Method used to log access to the webserver.
* @param s string to log
**/
virtual void log_access(const std::string& s) const;
/**
* Method used to log errors on the webserver.
* @param s string to log
**/
virtual void log_error(const std::string& s) const;
};
/**
* Delegate class used to validate requests before serve it
**/
class request_validator
{
public:
/**
* Delegate constructor
**/
request_validator();
/**
* Destructor of the class
**/
virtual ~request_validator();
/**
* Method used to validate a request. The validation method is entirely based upon the requestor address.
* @param address The requestor address
* @return true if the request is considered to be valid, false otherwise.
**/
virtual bool validate(const std::string& address) const;
};
/**
* Delegate class used to unescape requests uri before serving it.
**/
class unescaper
{
public:
/**
* Delegate constructor
**/
unescaper();
/**
* Destructor of the class
**/
virtual ~unescaper();
/**
* Method used to unescape the uri.
* @param s pointer to the uri string representation to unescape.
**/
virtual void unescape(char* s) const;
};
/*
class cache_object
{
public:
enum mode_T { WRITE, READ };
~cache_object();
private:
cache_entry* elem;
mode_T mode;
cache_object(const modeT& mode);
};
*/
class create_webserver;
/**
* Class representing the webserver. Main class of the apis.
**/
class webserver
{
public:
/**
* Constructor of the class.
* @param port Integer representing the port the webserver is listening on.
* @param start_method
* @param max_threads max number of serving threads (0 -> infty)
* @param max_connections max number of allowed connections (0 -> infty).
* @param memory_limit max memory allocated to serve requests (0 -> infty).
* @param per_IP_connection_limit max number of connections allowed for a single IP (0 -> infty).
* @param log_delegate logging_delegate object used to log
* @param validator request_validator object used to validate requestors
* @param unescaper unescaper object used to unescape urls.
* @param max_thread_stack_size max dimesion of request stack
* @param https_mem_key used with https. Private key used for requests.
* @param https_mem_cert used with https. Certificate used for requests.
* @param https_mem_trust used with https. CA Certificate used to trust request certificates.
* @param https_priorities used with https. Determinates the SSL/TLS version to be used.
* @param cred_type used with https. Daemon credential type. Can be NONE, certificate or anonymous.
* @param digest_auth_random used with https. Digest authentication nonce's seed.
* @param nonce_nc_size used with https. Size of an array of nonce and nonce counter map.
**/
explicit webserver
(
int port = DEFAULT_WS_PORT,
const http_utils::start_method_T& start_method = http_utils::INTERNAL_SELECT,
int max_threads = 0,
int max_connections = 0,
int memory_limit = 0,
int connection_timeout = DEFAULT_WS_TIMEOUT,
int per_IP_connection_limit = 0,
logging_delegate* log_delegate = 0x0,
request_validator* validator = 0x0,
unescaper* unescaper_pointer = 0x0,
const struct sockaddr* bind_address = 0x0,
int bind_socket = 0,
int max_thread_stack_size = 0,
bool use_ssl = false,
bool use_ipv6 = false,
bool debug = false,
bool pedantic = false,
const std::string& https_mem_key = "",
const std::string& https_mem_cert = "",
const std::string& https_mem_trust = "",
const std::string& https_priorities = "",
const http_utils::cred_type_T& cred_type= http_utils::NONE,
const std::string digest_auth_random = "", //IT'S CORRECT TO PASS THIS PARAMETER BY VALUE
int nonce_nc_size = 0,
const http_utils::policy_T& default_policy = http_utils::ACCEPT,
bool basic_auth_enabled = true,
bool digest_auth_enabled = true,
bool regex_checking = true,
bool ban_system_enabled = true,
bool post_process_enabled = true,
http_resource* single_resource = 0x0,
http_resource* not_found_resource = 0x0,
http_resource* method_not_allowed_resource = 0x0,
http_resource* method_not_acceptable_resource = 0x0,
http_resource* internal_error_resource = 0x0
);
webserver(const create_webserver& params);
webserver& operator=(const webserver& b);
/**
* Destructor of the class
**/
~webserver();
/**
* Method used to start the webserver.
* This method can be blocking or not.
* @param blocking param indicating if the method is blocking or not
* @return a boolean indicating if the webserver is running or not.
**/
bool start(bool blocking = false);
/**
* Method used to stop the webserver.
* @return true if the webserver is stopped.
**/
bool stop();
/**
* Method used to evaluate if the server is running or not.
* @return true if the webserver is running
**/
bool is_running();
/**
* Method used to registrate a resource to the webserver.
* @param resource The url pointing to the resource. This url could be also parametrized in the form /path/to/url/{par1}/and/{par2}
* or a regular expression.
* @param http_resource http_resource pointer to register.
* @param family boolean indicating whether the resource is registered for the endpoint and its child or not.
**/
void register_resource(const std::string& resource, http_resource* http_resource, bool family = false);
void unregister_resource(const std::string& resource);
void ban_ip(const std::string& ip);
void allow_ip(const std::string& ip);
void unban_ip(const std::string& ip);
void disallow_ip(const std::string& ip);
void send_message_to_topic(const std::string& topic, const std::string& message);
void send_message_to_consumer(int connection_id, const std::string& message, bool to_lock = true);
void register_to_topics(const std::vector<std::string>& topics, int connection_id, int keepalive_secs = -1, std::string keepalive_msg = "");
size_t read_message(int connection_id, std::string& message);
size_t get_topic_consumers(const std::string& topic, std::set<int>& consumers);
bool pop_signaled(int consumer);
http_response* get_from_cache(const std::string& key, bool* valid, bool lock = false, bool write = false);
http_response* get_from_cache(const std::string& key, bool* valid, cache_entry** ce, bool lock = false, bool write = false);
void lock_cache_element(const std::string& key, bool write = false);
void unlock_cache_element(const std::string& key);
cache_entry* put_in_cache(const std::string& key, http_response* value, bool* new_elem, bool lock = false, bool write = false, int validity = -1);
void remove_from_cache(const std::string& key);
bool is_valid(const std::string& key);
void clean_cache();
const logging_delegate* get_logging_delegate() const;
void set_logging_delegate(logging_delegate* log_delegate, bool delete_old = false);
const request_validator* get_request_validator() const;
void set_request_validator(request_validator* validator, bool delete_old = false);
const unescaper* get_unescaper() const;
void set_unescaper(unescaper* unescaper_pointer, bool delete_old = false);
/**
* Method used to kill the webserver waiting for it to terminate
**/
void sweet_kill();
private:
int port;
http_utils::start_method_T start_method;
int max_threads;
int max_connections;
int memory_limit;
int connection_timeout;
int per_IP_connection_limit;
logging_delegate* log_delegate;
request_validator* validator;
unescaper* unescaper_pointer;
const struct sockaddr* bind_address;
int bind_socket;
int max_thread_stack_size;
bool use_ssl;
bool use_ipv6;
bool debug;
bool pedantic;
std::string https_mem_key;
std::string https_mem_cert;
std::string https_mem_trust;
std::string https_priorities;
http_utils::cred_type_T cred_type;
std::string digest_auth_random;
int nonce_nc_size;
bool running;
http_utils::policy_T default_policy;
bool basic_auth_enabled;
bool digest_auth_enabled;
bool regex_checking;
bool ban_system_enabled;
bool post_process_enabled;
bool single_resource;
pthread_mutex_t mutexwait;
pthread_mutex_t runguard;
pthread_mutex_t cleanmux;
pthread_cond_t mutexcond;
pthread_cond_t cleancond;
http_resource* not_found_resource;
http_resource* method_not_allowed_resource;
http_resource* method_not_acceptable_resource;
http_resource* internal_error_resource;
std::map<details::http_endpoint, http_resource* > registered_resources;
pthread_rwlock_t cache_guard;
std::map<std::string, cache_entry*> response_cache;
#ifdef USE_CPP_ZEROX
std::unordered_set<ip_representation> bans;
std::unordered_set<ip_representation> allowances;
#else
std::set<ip_representation> bans;
std::set<ip_representation> allowances;
#endif
// std::map<std::string, std::string> q_messages;
std::map<int, std::deque<std::string> > q_messages;
std::map<std::string, std::set<int> > q_waitings;
std::map<int, std::pair<pthread_mutex_t, pthread_cond_t> > q_blocks;
std::set<int> q_signal;
std::map<int, long> q_keepalives;
std::map<int, std::pair<int, std::string> > q_keepalives_mem;
pthread_rwlock_t comet_guard;
std::vector<details::daemon_item*> daemons;
std::vector<pthread_t> threads;
void init(http_resource* single_resource);
static void* select(void* self);
void schedule_fd(int fd, fd_set* schedule_list, int* max);
static void* cleaner(void* self);
void clean_connections();
void method_not_allowed_page(http_response** dhrs, details::modded_request* mr);
void internal_error_page(http_response** dhrs, details::modded_request* mr, bool force_our = false);
void not_found_page(http_response** dhrs, details::modded_request* mr);
static int method_not_acceptable_page
(
const void *cls,
struct MHD_Connection *connection
);
static void request_completed(void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe);
static int build_request_header (void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
static int build_request_footer (void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
static int build_request_cookie (void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
static int build_request_args (void *cls, enum MHD_ValueKind kind, const char *key, const char *value);
static int answer_to_connection
(
void* cls, MHD_Connection* connection,
const char* url, const char* method,
const char* version, const char* upload_data,
size_t* upload_data_size, void** con_cls
);
static int post_iterator
(
void *cls,
enum MHD_ValueKind kind,
const char *key,
const char *filename,
const char *content_type,
const char *transfer_encoding,
const char *data, uint64_t off, size_t size
);
static void upgrade_handler
(
void *cls,
struct MHD_Connection* connection,
void **con_cls, int upgrade_socket
);
int bodyless_requests_answer(MHD_Connection* connection,
const char* url, const char* method,
const char* version, struct details::modded_request* mr
);
int bodyfull_requests_answer_first_step(MHD_Connection* connection, struct details::modded_request* mr);
int bodyfull_requests_answer_second_step(MHD_Connection* connection,
const char* url, const char* method,
const char* version, const char* upload_data,
size_t* upload_data_size, struct details::modded_request* mr
);
void end_request_construction(MHD_Connection* connection,
struct details::modded_request* mr, const char* version,
const char* st_url, const char* method,
char* user, char* pass, char* digested_user
);
int finalize_answer(MHD_Connection* connection,
struct details::modded_request* mr, const char* st_url,
const char* method
);
int complete_request(MHD_Connection* connection,
struct details::modded_request* mr, const char* version,
const char* st_url, const char* method
);
bool use_internal_select()
{
return this->start_method == http_utils::INTERNAL_SELECT;
}
friend int policy_callback (void *cls, const struct sockaddr* addr, socklen_t addrlen);
friend void error_log(void* cls, const char* fmt, va_list ap);
friend void access_log(webserver* cls, std::string uri);
friend void* uri_log(void* cls, const char* uri);
friend size_t unescaper_func(void * cls, struct MHD_Connection *c, char *s);
friend size_t internal_unescaper(void * cls, char *s);
friend class cache_response;
};
class create_webserver
{
public:
create_webserver():
_port(DEFAULT_WS_PORT),
_start_method(http_utils::INTERNAL_SELECT),
_max_threads(0),
_max_connections(0),
_memory_limit(0),
_connection_timeout(DEFAULT_WS_TIMEOUT),
_per_IP_connection_limit(0),
_log_delegate(0x0),
_validator(0x0),
_unescaper_pointer(0x0),
_bind_address(0x0),
_bind_socket(0),
_max_thread_stack_size(0),
_use_ssl(false),
_use_ipv6(false),
_debug(false),
_pedantic(false),
_https_mem_key(""),
_https_mem_cert(""),
_https_mem_trust(""),
_https_priorities(""),
_cred_type(http_utils::NONE),
_digest_auth_random(""),
_nonce_nc_size(0),
_default_policy(http_utils::ACCEPT),
_basic_auth_enabled(true),
_digest_auth_enabled(true),
_regex_checking(true),
_ban_system_enabled(true),
_post_process_enabled(true),
_single_resource(0x0),
_not_found_resource(0x0),
_method_not_allowed_resource(0x0),
_method_not_acceptable_resource(0x0),
_internal_error_resource(0x0)
{
}
explicit create_webserver(int port):
_port(port),
_start_method(http_utils::INTERNAL_SELECT),
_max_threads(0),
_max_connections(0),
_memory_limit(0),
_connection_timeout(DEFAULT_WS_TIMEOUT),
_per_IP_connection_limit(0),
_log_delegate(0x0),
_validator(0x0),
_unescaper_pointer(0x0),
_bind_address(0x0),
_bind_socket(0),
_max_thread_stack_size(0),
_use_ssl(false),
_use_ipv6(false),
_debug(false),
_pedantic(false),
_https_mem_key(""),
_https_mem_cert(""),
_https_mem_trust(""),
_https_priorities(""),
_cred_type(http_utils::NONE),
_digest_auth_random(""),
_nonce_nc_size(0),
_default_policy(http_utils::ACCEPT),
_basic_auth_enabled(true),
_digest_auth_enabled(true),
_regex_checking(true),
_ban_system_enabled(true),
_post_process_enabled(true),
_single_resource(0x0),
_not_found_resource(0x0),
_method_not_allowed_resource(0x0),
_method_not_acceptable_resource(0x0),
_internal_error_resource(0x0)
{
}
create_webserver& port(int port) { _port = port; return *this; }
create_webserver& start_method(const http_utils::start_method_T& start_method) { _start_method = start_method; return *this; }
create_webserver& max_threads(int max_threads) { _max_threads = max_threads; return *this; }
create_webserver& max_connections(int max_connections) { _max_connections = max_connections; return *this; }
create_webserver& memory_limit(int memory_limit) { _memory_limit = memory_limit; return *this; }
create_webserver& connection_timeout(int connection_timeout) { _connection_timeout = connection_timeout; return *this; }
create_webserver& per_IP_connection_limit(int per_IP_connection_limit) { _per_IP_connection_limit = per_IP_connection_limit; return *this; }
create_webserver& log_delegate(logging_delegate* log_delegate) { _log_delegate = log_delegate; return *this; }
create_webserver& validator(request_validator* validator) { _validator = validator; return *this; }
create_webserver& unescaper_pointer(unescaper* unescaper_pointer) { _unescaper_pointer = unescaper_pointer; return *this; }
create_webserver& bind_address(const struct sockaddr* bind_address) { _bind_address = bind_address; return *this; }
create_webserver& bind_socket(int bind_socket) { _bind_socket = bind_socket; return *this; }
create_webserver& max_thread_stack_size(int max_thread_stack_size) { _max_thread_stack_size = max_thread_stack_size; return *this; }
create_webserver& use_ssl() { _use_ssl = true; return *this; }
create_webserver& no_ssl() { _use_ssl = false; return *this; }
create_webserver& use_ipv6() { _use_ipv6 = true; return *this; }
create_webserver& no_ipv6() { _use_ipv6 = false; return *this; }
create_webserver& debug() { _debug = true; return *this; }
create_webserver& no_debug() { _debug = false; return *this; }
create_webserver& pedantic() { _pedantic = true; return *this; }
create_webserver& no_pedantic() { _pedantic = false; return *this; }
create_webserver& https_mem_key(const std::string& https_mem_key);
create_webserver& https_mem_cert(const std::string& https_mem_cert);
create_webserver& https_mem_trust(const std::string& https_mem_trust);
create_webserver& raw_https_mem_key(const std::string& https_mem_key) { _https_mem_key = https_mem_key; return *this; }
create_webserver& raw_https_mem_cert(const std::string& https_mem_cert) { _https_mem_cert = https_mem_cert; return *this; }
create_webserver& raw_https_mem_trust(const std::string& https_mem_trust) { _https_mem_trust = https_mem_trust; return *this; }
create_webserver& https_priorities(const std::string& https_priorities) { _https_priorities = https_priorities; return *this; }
create_webserver& cred_type(const http_utils::cred_type_T& cred_type) { _cred_type = cred_type; return *this; }
create_webserver& digest_auth_random(const std::string& digest_auth_random) { _digest_auth_random = digest_auth_random; return *this; }
create_webserver& nonce_nc_size(int nonce_nc_size) { _nonce_nc_size = nonce_nc_size; return *this; }
create_webserver& default_policy(const http_utils::policy_T& default_policy) { _default_policy = default_policy; return *this; }
create_webserver& basic_auth() { _basic_auth_enabled = true; return *this; }
create_webserver& no_basic_auth() { _basic_auth_enabled = false; return *this; }
create_webserver& digest_auth() { _digest_auth_enabled = true; return *this; }
create_webserver& no_digest_auth() { _digest_auth_enabled = false; return *this; }
create_webserver& regex_checking() { _regex_checking = true; return *this; }
create_webserver& no_regex_checking() { _regex_checking = false; return *this; }
create_webserver& ban_system() { _ban_system_enabled = true; return *this; }
create_webserver& no_ban_system() { _ban_system_enabled = false; return *this; }
create_webserver& post_process() { _post_process_enabled = true; return *this; }
create_webserver& no_post_process() { _post_process_enabled = false; return *this; }
create_webserver& single_resource(http_resource* single_resource) { _single_resource = single_resource; return *this; }
create_webserver& not_found_resource(http_resource* not_found_resource) { _not_found_resource = not_found_resource; return *this; }
create_webserver& method_not_allowed_resource(http_resource* method_not_allowed_resource) { _method_not_allowed_resource = method_not_allowed_resource; return *this; }
create_webserver& method_not_acceptable_resource(http_resource* method_not_acceptable_resource) { _method_not_acceptable_resource = method_not_acceptable_resource; return *this; }
create_webserver& internal_error_resource(http_resource* internal_error_resource) { _internal_error_resource = internal_error_resource; return *this; }
private:
int _port;
http_utils::start_method_T _start_method;
int _max_threads;
int _max_connections;
int _memory_limit;
int _connection_timeout;
int _per_IP_connection_limit;
logging_delegate* _log_delegate;
request_validator* _validator;
unescaper* _unescaper_pointer;
const struct sockaddr* _bind_address;
int _bind_socket;
int _max_thread_stack_size;
bool _use_ssl;
bool _use_ipv6;
bool _debug;
bool _pedantic;
std::string _https_mem_key;
std::string _https_mem_cert;
std::string _https_mem_trust;
std::string _https_priorities;
http_utils::cred_type_T _cred_type;
std::string _digest_auth_random;
int _nonce_nc_size;
http_utils::policy_T _default_policy;
bool _basic_auth_enabled;
bool _digest_auth_enabled;
bool _regex_checking;
bool _ban_system_enabled;
bool _post_process_enabled;
http_resource* _single_resource;
http_resource* _not_found_resource;
http_resource* _method_not_allowed_resource;
http_resource* _method_not_acceptable_resource;
http_resource* _internal_error_resource;
friend class webserver;
};
};
#endif //_FRAMEWORK_WEBSERVER_HPP__