forked from zerotao/libevhtp
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathevhtp.h
1395 lines (1207 loc) · 45 KB
/
evhtp.h
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
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include <evhtp-config.h>
#ifndef __EVHTP__H__
#define __EVHTP__H__
/** @file */
#ifndef EVHTP_DISABLE_EVTHR
#include <evthr.h>
#endif
#include <htparse.h>
#ifndef EVHTP_DISABLE_REGEX
#include <onigposix.h>
#endif
#include <sys/queue.h>
#include <event2/event.h>
#include <event2/listener.h>
#include <event2/buffer.h>
#include <event2/bufferevent.h>
#ifndef EVHTP_DISABLE_SSL
#include <event2/bufferevent_ssl.h>
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/rand.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
#ifdef EVHTP_DEBUG
#define __QUOTE(x) # x
#define _QUOTE(x) __QUOTE(x)
#define htp_debug_strlen(x) strlen(x)
#define htp_log_debug(fmt, ...) do { \
time_t t = time(NULL); \
struct tm * dm = localtime(&t); \
\
fprintf(stdout, "[%02d:%02d:%02d] evhtp.c:[" _QUOTE(__LINE__) "]\t %-26s: " \
fmt "\n", dm->tm_hour, dm->tm_min, dm->tm_sec, __func__, ## __VA_ARGS__); \
fflush(stdout); \
} while (0)
#else
#define htp_debug_strlen(x) 0
#define htp_log_debug(fmt, ...) do {} while (0)
#endif
#ifndef EVHTP_DISABLE_SSL
typedef SSL_SESSION evhtp_ssl_sess_t;
typedef SSL evhtp_ssl_t;
typedef SSL_CTX evhtp_ssl_ctx_t;
typedef X509 evhtp_x509_t;
typedef X509_STORE_CTX evhtp_x509_store_ctx_t;
#else
typedef void evhtp_ssl_sess_t;
typedef void evhtp_ssl_t;
typedef void evhtp_ssl_ctx_t;
typedef void evhtp_x509_t;
typedef void evhtp_x509_store_ctx_t;
#endif
typedef struct evbuffer evbuf_t;
typedef struct event event_t;
typedef struct evconnlistener evserv_t;
typedef struct bufferevent evbev_t;
#ifdef EVHTP_DISABLE_EVTHR
typedef struct event_base evbase_t;
typedef void evthr_t;
typedef void evthr_pool_t;
typedef void evhtp_mutex_t;
#else
typedef pthread_mutex_t evhtp_mutex_t;
#endif
typedef struct evhtp_s evhtp_t;
typedef struct evhtp_defaults_s evhtp_defaults_t;
typedef struct evhtp_callbacks_s evhtp_callbacks_t;
typedef struct evhtp_callback_s evhtp_callback_t;
typedef struct evhtp_defaults_s evhtp_defaults_5;
typedef struct evhtp_kv_s evhtp_kv_t;
typedef struct evhtp_kvs_s evhtp_kvs_t;
typedef struct evhtp_uri_s evhtp_uri_t;
typedef struct evhtp_path_s evhtp_path_t;
typedef struct evhtp_authority_s evhtp_authority_t;
typedef struct evhtp_request_s evhtp_request_t;
typedef struct evhtp_hooks_s evhtp_hooks_t;
typedef struct evhtp_connection_s evhtp_connection_t;
typedef struct evhtp_ssl_cfg_s evhtp_ssl_cfg_t;
typedef struct evhtp_alias_s evhtp_alias_t;
typedef uint16_t evhtp_res;
typedef uint8_t evhtp_error_flags;
#define evhtp_header_s evhtp_kv_s
#define evhtp_headers_s evhtp_kvs_s
#define evhtp_query_s evhtp_kvs_s
#define evhtp_header_t evhtp_kv_t
#define evhtp_headers_t evhtp_kvs_t
#define evhtp_query_t evhtp_kvs_t
enum evhtp_ssl_scache_type {
evhtp_ssl_scache_type_disabled = 0,
evhtp_ssl_scache_type_internal,
evhtp_ssl_scache_type_user,
evhtp_ssl_scache_type_builtin
};
/**
* @brief types associated with where a developer can hook into
* during the request processing cycle.
*/
enum evhtp_hook_type {
evhtp_hook_on_header, /**< type which defines to hook after one header has been parsed */
evhtp_hook_on_headers, /**< type which defines to hook after all headers have been parsed */
evhtp_hook_on_path, /**< type which defines to hook once a path has been parsed */
evhtp_hook_on_read, /**< type which defines to hook whenever the parser recieves data in a body */
evhtp_hook_on_request_fini, /**< type which defines to hook before the request is free'd */
evhtp_hook_on_connection_fini,
evhtp_hook_on_new_chunk,
evhtp_hook_on_chunk_complete,
evhtp_hook_on_chunks_complete,
evhtp_hook_on_headers_start,
evhtp_hook_on_error, /**< type which defines to hook whenever an error occurs */
evhtp_hook_on_hostname,
evhtp_hook_on_write,
evhtp_hook_on_event,
evhtp_hook_on_conn_error, /**< type which defines to hook whenever a connection error occurs */
};
enum evhtp_callback_type {
evhtp_callback_type_hash,
evhtp_callback_type_glob,
#ifndef EVHTP_DISABLE_REGEX
evhtp_callback_type_regex,
#endif
};
enum evhtp_proto {
EVHTP_PROTO_INVALID,
EVHTP_PROTO_10,
EVHTP_PROTO_11
};
enum evhtp_type {
evhtp_type_client,
evhtp_type_server
};
typedef enum evhtp_hook_type evhtp_hook_type;
typedef enum evhtp_callback_type evhtp_callback_type;
typedef enum evhtp_proto evhtp_proto;
typedef enum evhtp_ssl_scache_type evhtp_ssl_scache_type;
typedef enum evhtp_type evhtp_type;
typedef void (* evhtp_thread_init_cb)(evhtp_t * htp, evthr_t * thr, void * arg);
typedef void (* evhtp_thread_exit_cb)(evhtp_t * htp, evthr_t * thr, void * arg);
typedef void (* evhtp_callback_cb)(evhtp_request_t * req, void * arg);
typedef void (* evhtp_hook_err_cb)(evhtp_request_t * req, evhtp_error_flags errtype, void * arg);
typedef void (* evhtp_hook_event_cb)(evhtp_connection_t * conn, short events, void * arg);
/* Generic hook for passing ISO tests */
typedef evhtp_res (* evhtp_hook)();
typedef evhtp_res (* evhtp_hook_conn_err_cb)(evhtp_connection_t * connection, evhtp_error_flags errtype, void * arg);
typedef evhtp_res (* evhtp_pre_accept_cb)(evhtp_connection_t * conn, void * arg);
typedef evhtp_res (* evhtp_post_accept_cb)(evhtp_connection_t * conn, void * arg);
typedef evhtp_res (* evhtp_hook_header_cb)(evhtp_request_t * req, evhtp_header_t * hdr, void * arg);
typedef evhtp_res (* evhtp_hook_headers_cb)(evhtp_request_t * req, evhtp_headers_t * hdr, void * arg);
typedef evhtp_res (* evhtp_hook_path_cb)(evhtp_request_t * req, evhtp_path_t * path, void * arg);
typedef evhtp_res (* evhtp_hook_read_cb)(evhtp_request_t * req, evbuf_t * buf, void * arg);
typedef evhtp_res (* evhtp_hook_request_fini_cb)(evhtp_request_t * req, void * arg);
typedef evhtp_res (* evhtp_hook_connection_fini_cb)(evhtp_connection_t * connection, void * arg);
typedef evhtp_res (* evhtp_hook_chunk_new_cb)(evhtp_request_t * r, uint64_t len, void * arg);
typedef evhtp_res (* evhtp_hook_chunk_fini_cb)(evhtp_request_t * r, void * arg);
typedef evhtp_res (* evhtp_hook_chunks_fini_cb)(evhtp_request_t * r, void * arg);
typedef evhtp_res (* evhtp_hook_headers_start_cb)(evhtp_request_t * r, void * arg);
typedef evhtp_res (* evhtp_hook_hostname_cb)(evhtp_request_t * r, const char * hostname, void * arg);
typedef evhtp_res (* evhtp_hook_write_cb)(evhtp_connection_t * conn, void * arg);
typedef int (* evhtp_kvs_iterator)(evhtp_kv_t * kv, void * arg);
typedef int (* evhtp_headers_iterator)(evhtp_header_t * header, void * arg);
#ifndef EVHTP_DISABLE_SSL
typedef int (* evhtp_ssl_verify_cb)(int pre_verify, evhtp_x509_store_ctx_t * ctx);
typedef int (* evhtp_ssl_chk_issued_cb)(evhtp_x509_store_ctx_t * ctx, evhtp_x509_t * x, evhtp_x509_t * issuer);
typedef int (* evhtp_ssl_scache_add)(evhtp_connection_t * connection, unsigned char * sid, int sid_len, evhtp_ssl_sess_t * sess);
typedef void (* evhtp_ssl_scache_del)(evhtp_t * htp, unsigned char * sid, int sid_len);
typedef evhtp_ssl_sess_t * (* evhtp_ssl_scache_get)(evhtp_connection_t * connection, unsigned char * sid, int sid_len);
typedef void * (* evhtp_ssl_scache_init)(evhtp_t *);
#endif
#define EVHTP_VERSION "1.2.11"
#define EVHTP_VERSION_MAJOR 1
#define EVHTP_VERSION_MINOR 2
#define EVHTP_VERSION_PATCH 11
#define evhtp_headers_iterator evhtp_kvs_iterator
#define EVHTP_RES_ERROR 0
#define EVHTP_RES_PAUSE 1
#define EVHTP_RES_FATAL 2
#define EVHTP_RES_USER 3
#define EVHTP_RES_DATA_TOO_LONG 4
#define EVHTP_RES_OK 200
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#define EVHTP_RES_100 100
#define EVHTP_RES_CONTINUE 100
#define EVHTP_RES_SWITCH_PROTO 101
#define EVHTP_RES_PROCESSING 102
#define EVHTP_RES_URI_TOOLONG 122
#define EVHTP_RES_200 200
#define EVHTP_RES_CREATED 201
#define EVHTP_RES_ACCEPTED 202
#define EVHTP_RES_NAUTHINFO 203
#define EVHTP_RES_NOCONTENT 204
#define EVHTP_RES_RSTCONTENT 205
#define EVHTP_RES_PARTIAL 206
#define EVHTP_RES_MSTATUS 207
#define EVHTP_RES_IMUSED 226
#define EVHTP_RES_300 300
#define EVHTP_RES_MCHOICE 300
#define EVHTP_RES_MOVEDPERM 301
#define EVHTP_RES_FOUND 302
#define EVHTP_RES_SEEOTHER 303
#define EVHTP_RES_NOTMOD 304
#define EVHTP_RES_USEPROXY 305
#define EVHTP_RES_SWITCHPROXY 306
#define EVHTP_RES_TMPREDIR 307
#define EVHTP_RES_400 400
#define EVHTP_RES_BADREQ 400
#define EVHTP_RES_UNAUTH 401
#define EVHTP_RES_PAYREQ 402
#define EVHTP_RES_FORBIDDEN 403
#define EVHTP_RES_NOTFOUND 404
#define EVHTP_RES_METHNALLOWED 405
#define EVHTP_RES_NACCEPTABLE 406
#define EVHTP_RES_PROXYAUTHREQ 407
#define EVHTP_RES_TIMEOUT 408
#define EVHTP_RES_CONFLICT 409
#define EVHTP_RES_GONE 410
#define EVHTP_RES_LENREQ 411
#define EVHTP_RES_PRECONDFAIL 412
#define EVHTP_RES_ENTOOLARGE 413
#define EVHTP_RES_URITOOLARGE 414
#define EVHTP_RES_UNSUPPORTED 415
#define EVHTP_RES_RANGENOTSC 416
#define EVHTP_RES_EXPECTFAIL 417
#define EVHTP_RES_IAMATEAPOT 418
#define EVHTP_RES_500 500
#define EVHTP_RES_SERVERR 500
#define EVHTP_RES_NOTIMPL 501
#define EVHTP_RES_BADGATEWAY 502
#define EVHTP_RES_SERVUNAVAIL 503
#define EVHTP_RES_GWTIMEOUT 504
#define EVHTP_RES_VERNSUPPORT 505
#define EVHTP_RES_BWEXEED 509
#endif
struct evhtp_defaults_s {
evhtp_callback_cb cb;
evhtp_pre_accept_cb pre_accept;
evhtp_post_accept_cb post_accept;
void * cbarg;
void * pre_accept_cbarg;
void * post_accept_cbarg;
};
struct evhtp_alias_s {
char * alias;
TAILQ_ENTRY(evhtp_alias_s) next;
};
/**
* @brief main structure containing all configuration information
*/
struct evhtp_s {
evhtp_t * parent; /**< only when this is a vhost */
evbase_t * evbase; /**< the initialized event_base */
evserv_t * server; /**< the libevent listener struct */
char * server_name; /**< the name included in Host: responses */
void * arg; /**< user-defined evhtp_t specific arguments */
int bev_flags; /**< bufferevent flags to use on bufferevent_*_socket_new() */
uint64_t max_body_size;
uint64_t max_keepalive_requests;
uint8_t disable_100_cont : 1, /**< if set, evhtp will not respond to Expect: 100-continue */
enable_reuseport : 1,
enable_nodelay : 1,
enable_defer_accept : 1,
disable_parse_query_body : 1,
pad : 3;
int parser_flags; /**< default query flags to alter 'strictness' (see EVHTP_PARSE_QUERY_FLAG_*) */
#ifndef EVHTP_DISABLE_SSL
evhtp_ssl_ctx_t * ssl_ctx; /**< if ssl enabled, this is the servers CTX */
evhtp_ssl_cfg_t * ssl_cfg;
#endif
#ifndef EVHTP_DISABLE_EVTHR
evthr_pool_t * thr_pool; /**< connection threadpool */
pthread_mutex_t * lock; /**< parent lock for add/del cbs in threads */
evhtp_thread_init_cb thread_init_cb;
evhtp_thread_exit_cb thread_exit_cb;
/* keep backwards compat because I'm dumb and didn't
* make these structs private
*/
#define thread_init_cbarg thread_cbarg
void * thread_cbarg;
#endif
evhtp_callbacks_t * callbacks;
evhtp_defaults_t defaults;
struct timeval recv_timeo;
struct timeval send_timeo;
TAILQ_HEAD(, evhtp_alias_s) aliases;
TAILQ_HEAD(, evhtp_s) vhosts;
TAILQ_ENTRY(evhtp_s) next_vhost;
};
/**
* @brief structure containing a single callback and configuration
*
* The definition structure which is used within the evhtp_callbacks_t
* structure. This holds information about what should execute for either
* a single or regex path.
*
* For example, if you registered a callback to be executed on a request
* for "/herp/derp", your defined callback will be executed.
*
* Optionally you can set callback-specific hooks just like per-connection
* hooks using the same rules.
*
*/
struct evhtp_callback_s {
evhtp_callback_type type; /**< the type of callback (regex|path) */
evhtp_callback_cb cb; /**< the actual callback function */
unsigned int hash; /**< the full hash generated integer */
void * cbarg; /**< user-defind arguments passed to the cb */
evhtp_hooks_t * hooks; /**< per-callback hooks */
union {
char * path;
char * glob;
#ifndef EVHTP_DISABLE_REGEX
regex_t * regex;
#endif
} val;
TAILQ_ENTRY(evhtp_callback_s) next;
};
TAILQ_HEAD(evhtp_callbacks_s, evhtp_callback_s);
/**
* @brief a generic key/value structure
*/
struct evhtp_kv_s {
char * key;
char * val;
size_t klen;
size_t vlen;
char k_heaped; /**< set to 1 if the key can be free()'d */
char v_heaped; /**< set to 1 if the val can be free()'d */
TAILQ_ENTRY(evhtp_kv_s) next;
};
TAILQ_HEAD(evhtp_kvs_s, evhtp_kv_s);
/**
* @brief a generic container representing an entire URI strucutre
*/
struct evhtp_uri_s {
evhtp_authority_t * authority;
evhtp_path_t * path;
unsigned char * fragment; /**< data after '#' in uri */
unsigned char * query_raw; /**< the unparsed query arguments */
evhtp_query_t * query; /**< list of k/v for query arguments */
htp_scheme scheme; /**< set if a scheme is found */
};
/**
* @brief structure which represents authority information in a URI
*/
struct evhtp_authority_s {
char * username; /**< the username in URI (scheme://USER:.. */
char * password; /**< the password in URI (scheme://...:PASS.. */
char * hostname; /**< hostname if present in URI */
uint16_t port; /**< port if present in URI */
};
/**
* @brief structure which represents a URI path and or file
*/
struct evhtp_path_s {
char * full; /**< the full path+file (/a/b/c.html) */
char * path; /**< the path (/a/b/) */
char * file; /**< the filename if present (c.html) */
char * match_start;
char * match_end;
unsigned int matched_soff; /**< offset of where the uri starts
* mainly used for regex matching
*/
unsigned int matched_eoff; /**< offset of where the uri ends
* mainly used for regex matching
*/
};
/**
* @brief a structure containing all information for a http request.
*/
struct evhtp_request_s {
evhtp_t * htp; /**< the parent evhtp_t structure */
evhtp_connection_t * conn; /**< the associated connection */
evhtp_hooks_t * hooks; /**< request specific hooks */
evhtp_uri_t * uri; /**< request URI information */
evbuf_t * buffer_in; /**< buffer containing data from client */
evbuf_t * buffer_out; /**< buffer containing data to client */
evhtp_headers_t * headers_in; /**< headers from client */
evhtp_headers_t * headers_out; /**< headers to client */
evhtp_proto proto; /**< HTTP protocol used */
htp_method method; /**< HTTP method used */
evhtp_res status; /**< The HTTP response code or other error conditions */
uint8_t keepalive : 1, /**< set to 1 if the connection is keep-alive */
finished : 1, /**< set to 1 if the request is fully processed */
chunked : 1, /**< set to 1 if the request is chunked */
error : 1, /**< set if any sort of error has occurred. */
pad : 4; /**< to be used in evhtp2 for new stuff */
evhtp_callback_cb cb; /**< the function to call when fully processed */
void * cbarg; /**< argument which is passed to the cb function */
TAILQ_ENTRY(evhtp_request_s) next;
};
#define evhtp_request_content_len(r) htparser_get_content_length(r->conn->parser)
struct evhtp_connection_s {
evhtp_t * htp;
evbase_t * evbase;
evbev_t * bev;
#ifndef EVHTP_DISABLE_EVTHR
evthr_t * thread;
#endif
#ifndef EVHTP_DISABLE_SSL
evhtp_ssl_t * ssl;
#endif
evhtp_hooks_t * hooks;
htparser * parser;
event_t * resume_ev;
struct sockaddr * saddr;
struct timeval recv_timeo; /**< conn read timeouts (overrides global) */
struct timeval send_timeo; /**< conn write timeouts (overrides global) */
evutil_socket_t sock;
evhtp_request_t * request; /**< the request currently being processed */
uint64_t max_body_size;
uint64_t body_bytes_read;
uint64_t num_requests;
evhtp_type type; /**< server or client */
uint8_t error : 1,
owner : 1, /**< set to 1 if this structure owns the bufferevent */
vhost_via_sni : 1, /**< set to 1 if the vhost was found via SSL SNI */
paused : 1, /**< this connection has been marked as paused */
connected : 1, /**< client specific - set after successful connection */
waiting : 1, /**< used to make sure resuming happens AFTER sending a reply */
free_connection : 1,
keepalive : 1; /**< set to 1 after the first request has been processed and the connection is kept open */
struct evbuffer * scratch_buf; /**< always zero'd out after used */
#ifdef EVHTP_FUTURE_USE
TAILQ_HEAD(, evhtp_request_s) pending; /**< client pending data */
#endif
};
struct evhtp_hooks_s {
evhtp_hook_headers_start_cb on_headers_start;
evhtp_hook_header_cb on_header;
evhtp_hook_headers_cb on_headers;
evhtp_hook_path_cb on_path;
evhtp_hook_read_cb on_read;
evhtp_hook_request_fini_cb on_request_fini;
evhtp_hook_connection_fini_cb on_connection_fini;
evhtp_hook_conn_err_cb on_connection_error;
evhtp_hook_err_cb on_error;
evhtp_hook_chunk_new_cb on_new_chunk;
evhtp_hook_chunk_fini_cb on_chunk_fini;
evhtp_hook_chunks_fini_cb on_chunks_fini;
evhtp_hook_hostname_cb on_hostname;
evhtp_hook_write_cb on_write;
evhtp_hook_event_cb on_event;
void * on_headers_start_arg;
void * on_header_arg;
void * on_headers_arg;
void * on_path_arg;
void * on_read_arg;
void * on_request_fini_arg;
void * on_connection_fini_arg;
void * on_connection_error_arg;
void * on_error_arg;
void * on_new_chunk_arg;
void * on_chunk_fini_arg;
void * on_chunks_fini_arg;
void * on_hostname_arg;
void * on_write_arg;
void * on_event_arg;
};
#ifndef EVHTP_DISABLE_SSL
struct evhtp_ssl_cfg_s {
char * pemfile;
char * privfile;
char * cafile;
char * capath;
char * ciphers;
char * named_curve;
char * dhparams;
long ssl_opts;
long ssl_ctx_timeout;
int verify_peer;
int verify_depth;
evhtp_ssl_verify_cb x509_verify_cb;
evhtp_ssl_chk_issued_cb x509_chk_issued_cb;
long store_flags;
evhtp_ssl_scache_type scache_type;
long scache_timeout;
long scache_size;
evhtp_ssl_scache_init scache_init;
evhtp_ssl_scache_add scache_add;
evhtp_ssl_scache_get scache_get;
evhtp_ssl_scache_del scache_del;
void * args;
};
#endif
/**
* @brief creates a new evhtp_t instance
*
* @param evbase the initialized event base
* @param arg user-defined argument which is evhtp_t specific
*
* @return a new evhtp_t structure or NULL on error
*/
EVHTP_EXPORT evhtp_t * evhtp_new(evbase_t * evbase, void * arg);
EVHTP_EXPORT void evhtp_free(evhtp_t * evhtp);
/**
* @brief set a read/write timeout on all things evhtp_t. When the timeout
* expires your error hook will be called with the libevent supplied event
* flags.
*
* @param htp the base evhtp_t struct
* @param r read-timeout in timeval
* @param w write-timeout in timeval.
*/
EVHTP_EXPORT void evhtp_set_timeouts(evhtp_t * htp, const struct timeval * r, const struct timeval * w);
/**
* @brief during the request processing cycle, these flags will be used to
* for query argument parsing. i.e., what to parse and not to parse.
*
* SEE: EVHTP_PARSE_QUERY_* stuff.
*
* For example, if you do not wish for the streaming parser attempting the act
* of fragment parsing:
* evhtp_set_parser_flags(htp, EVHTP_PARSE_QUERY_FLAG_IGNORE_FRAGMENTS);
*
* @param htp
* @param flags
*/
EVHTP_EXPORT void evhtp_set_parser_flags(evhtp_t * htp, int flags);
/**
* @brief bufferevent flags which will be used for bev sockets.
*
* @param htp
* @param flags
*/
EVHTP_EXPORT void evhtp_set_bev_flags(evhtp_t * htp, int flags);
#ifndef EVHTP_DISABLE_SSL
EVHTP_EXPORT int evhtp_ssl_use_threads(void);
EVHTP_EXPORT int evhtp_ssl_init(evhtp_t * htp, evhtp_ssl_cfg_t * ssl_cfg);
#endif
/**
* @brief when a client sends an Expect: 100-continue, if this is function is
* called, evhtp will not send a HTTP/x.x continue response.
*
* @param htp
*/
EVHTP_EXPORT void evhtp_disable_100_continue(evhtp_t * htp);
/**
* @brief creates a lock around callbacks and hooks, allowing for threaded
* applications to add/remove/modify hooks & callbacks in a thread-safe manner.
*
* @param htp
*
* @return 0 on success, -1 on error
*/
EVHTP_EXPORT int evhtp_use_callback_locks(evhtp_t * htp);
/**
* @brief sets a callback which is called if no other callbacks are matched
*
* @param htp the initialized evhtp_t
* @param cb the function to be executed
* @param arg user-defined argument passed to the callback
*/
EVHTP_EXPORT void evhtp_set_gencb(evhtp_t * htp, evhtp_callback_cb cb, void * arg);
/**
* @brief call a user-defined function before the connection is accepted.
*
* @param htp
* @param evhtp_pre_accept_cb
* @param arg
*
* @return
*/
EVHTP_EXPORT void evhtp_set_pre_accept_cb(evhtp_t * htp, evhtp_pre_accept_cb, void * arg);
/**
* @brief call a user-defined function right after a connection is accepted.
*
* @param htp
* @param evhtp_post_accept_cb
* @param arg
*
* @return
*/
EVHTP_EXPORT void evhtp_set_post_accept_cb(evhtp_t * htp, evhtp_post_accept_cb, void * arg);
/**
* @brief sets a callback to be executed on a specific path
*
* @param htp the initialized evhtp_t
* @param path the path to match
* @param cb the function to be executed
* @param arg user-defined argument passed to the callback
*
* @return evhtp_callback_t * on success, NULL on error.
*/
EVHTP_EXPORT evhtp_callback_t * evhtp_set_cb(evhtp_t * htp, const char * path,
evhtp_callback_cb cb, void * arg);
/**
* @brief sets a callback to be executed based on a regex pattern
*
* @param htp the initialized evhtp_t
* @param pattern a POSIX compat regular expression
* @param cb the function to be executed
* @param arg user-defined argument passed to the callback
*
* @return evhtp_callback_t * on success, NULL on error
*/
#ifndef EVHTP_DISABLE_REGEX
EVHTP_EXPORT evhtp_callback_t * evhtp_set_regex_cb(evhtp_t * htp, const char * pattern,
evhtp_callback_cb cb, void * arg);
#endif
/**
* @brief sets a callback to to be executed on simple glob/wildcard patterns
* this is useful if the app does not care about what was matched, but
* just that it matched. This is technically faster than regex.
*
* @param htp
* @param pattern wildcard pattern, the '*' can be set at either or both the front or end.
* @param cb
* @param arg
*
* @return
*/
EVHTP_EXPORT evhtp_callback_t * evhtp_set_glob_cb(evhtp_t * htp, const char * pattern,
evhtp_callback_cb cb, void * arg);
/**
* @brief attempts to find the callback matching the exact string 'needle'. This is useful
* in cases where we want to get the original handle, but is not in scope.
*
* with pattern based callbacks, this does not attempt to find a callback that would
* match the string if the pattern matcher was executed.
*
* Meaning:
* evhtp_set_glob_cb(htp, "/foo/bar*", ....);
*
* Calling
* evhtp_get_cb(htp, "/foo/bar/baz");
*
* Will return NULL since it's not the exact pattern set
*
* Calling
* evhtp_get_cb(htp, "/foo/bar*");
*
* Is the correct usage.
*
* @param htp
* @param needle
*
* @return NULL if callback is not not found
*/
EVHTP_EXPORT evhtp_callback_t * evhtp_get_cb(evhtp_t * htp, const char * needle);
/**
* @brief sets a callback hook for either a connection or a path/regex .
*
* A user may set a variety of hooks either per-connection, or per-callback.
* This allows the developer to hook into various parts of the request processing
* cycle.
*
* a per-connection hook can be set at any time, but it is recommended to set these
* during either a pre-accept phase, or post-accept phase. This allows a developer
* to set hooks before any other hooks are called.
*
* a per-callback hook works differently. In this mode a developer can setup a set
* of hooks prior to starting the event loop for specific callbacks. For example
* if you wanted to hook something ONLY for a callback set by evhtp_set_cb or
* evhtp_set_regex_cb this is the method of doing so.
*
* per-callback example:
*
* evhtp_callback_t * cb = evhtp_set_regex_cb(htp, "/anything/(.*)", default_cb, NULL);
*
* evhtp_set_hook(&cb->hooks, evhtp_hook_on_headers, anything_headers_cb, NULL);
*
* evhtp_set_hook(&cb->hooks, evhtp_hook_on_fini, anything_fini_cb, NULL);
*
* With the above example, once libevhtp has determined that it has a user-defined
* callback for /anything/.*; anything_headers_cb will be executed after all headers
* have been parsed, and anything_fini_cb will be executed before the request is
* free()'d.
*
* The same logic applies to per-connection hooks, but it should be noted that if
* a per-callback hook is set, the per-connection hook will be ignored.
*
* @param hooks double pointer to the evhtp_hooks_t structure
* @param type the hook type
* @param cb the callback to be executed.
* @param arg optional argument which is passed when the callback is executed
*
* @return 0 on success, -1 on error (if hooks is NULL, it is allocated)
*/
EVHTP_EXPORT int evhtp_set_hook(evhtp_hooks_t ** hooks, evhtp_hook_type type,
evhtp_hook cb, void * arg);
/**
* @brief remove a specific hook from being called.
*
* @param hooks
* @param type
*
* @return
*/
EVHTP_EXPORT int evhtp_unset_hook(evhtp_hooks_t ** hooks, evhtp_hook_type type);
/**
* @brief removes all hooks.
*
* @param hooks
*
* @return
*/
EVHTP_EXPORT int evhtp_unset_all_hooks(evhtp_hooks_t ** hooks);
/**
* @brief bind to a socket, optionally with specific protocol support
* formatting. The addr can be defined as one of the following:
* ipv6:<ipv6addr> for binding to an IPv6 address.
* unix:<named pipe> for binding to a unix named socket
* ipv4:<ipv4addr> for binding to an ipv4 address
* Otherwise the addr is assumed to be ipv4.
*
* @param htp
* @param addr
* @param port
* @param backlog
*
* @return
*/
EVHTP_EXPORT int evhtp_bind_socket(evhtp_t * htp, const char * addr, uint16_t port, int backlog);
/**
* @brief stops the listening socket.
*
* @param htp
*/
EVHTP_EXPORT void evhtp_unbind_socket(evhtp_t * htp);
/**
* @brief create the listener plus setup various options with an already-bound
* socket.
*
* @param htp
* @param sock
* @param backlog
*
* @return 0 on success, -1 on error (check errno)
*/
EVHTP_EXPORT int evhtp_accept_socket(evhtp_t * htp, evutil_socket_t sock, int backlog);
/**
* @brief bind to an already allocated sockaddr.
*
* @param htp
* @parami s
* @param sin_len
* @param backlog
*
* @return
*/
EVHTP_EXPORT int evhtp_bind_sockaddr(evhtp_t * htp, struct sockaddr *,
size_t sin_len, int backlog);
/**
* @brief Enable thread-pool support for an evhtp_t context. Connectios are
* distributed across 'nthreads'. An optional "on-start" callback can
* be set which allows you to manipulate the thread-specific inforation
* (such as the thread-specific event_base).
*
* @param htp
* @param init_cb
* @param exit_cb
* @param nthreads
* @param arg
*
* @return
*/
DEPRECATED("will take on the syntax of evhtp_use_threads_wexit")
EVHTP_EXPORT int evhtp_use_threads(evhtp_t *, evhtp_thread_init_cb, int nthreads, void *);
/**
* @brief Temporary function which will be renamed evhtp_use_threads in the
* future. evhtp_use_threads() has been noted as deprecated for now
*/
EVHTP_EXPORT int evhtp_use_threads_wexit(evhtp_t *,
evhtp_thread_init_cb,
evhtp_thread_exit_cb,
int nthreads, void * arg);
/**
* @brief generates all the right information for a reply to be sent to the client
*
* @param request
* @param code HTTP return status code
*/
EVHTP_EXPORT void evhtp_send_reply(evhtp_request_t * request, evhtp_res code);
/* The following three functions allow for the user to do what evhtp_send_reply does at its core
* but for the weak of heart.
*/
EVHTP_EXPORT void evhtp_send_reply_start(evhtp_request_t * request, evhtp_res code);
EVHTP_EXPORT void evhtp_send_reply_body(evhtp_request_t * request, evbuf_t * buf);
EVHTP_EXPORT void evhtp_send_reply_end(evhtp_request_t * request);
/**
* @brief Determine if a response should have a body.
* Follows the rules in RFC 2616 section 4.3.
* @return 1 if the response MUST have a body; 0 if the response MUST NOT have
* a body.
*/
EVHTP_EXPORT int evhtp_response_needs_body(const evhtp_res code, const htp_method method);
/**
* @brief start a chunked response. If data already exists on the output buffer,
* this will be converted to the first chunk.
*
* @param request
* @param code
*/
EVHTP_EXPORT void evhtp_send_reply_chunk_start(evhtp_request_t * request, evhtp_res code);
/**
* @brief send a chunk reply.
*
* @param request
* @param buf
*/
EVHTP_EXPORT void evhtp_send_reply_chunk(evhtp_request_t * request, evbuf_t * buf);
/**
* @brief call when all chunks have been sent and you wish to send the last
* bits. This will add the last 0CRLFCRCL and call send_reply_end().
*
* @param request
*/
EVHTP_EXPORT void evhtp_send_reply_chunk_end(evhtp_request_t * request);
/**
* @brief creates a new evhtp_callback_t structure.
*
* All callbacks are stored in this structure
* which define what the final function to be
* called after all parsing is done. A callback
* can be either a static string or a regular
* expression.
*
* @param path can either be a static path (/path/to/resource/) or
* a POSIX compatible regular expression (^/resource/(.*))
* @param type informs the function what type of of information is
* is contained within the path argument. This can either be
* callback_type_path, or callback_type_regex.
* @param cb the callback function to be invoked
* @param arg optional argument which is passed when the callback is executed.
*
* @return 0 on success, -1 on error.
*/
EVHTP_EXPORT evhtp_callback_t *
evhtp_callback_new(const char * path, evhtp_callback_type type, evhtp_callback_cb cb, void * arg);
/**
* @brief frees information associated with a ainflwx callback.
*
* @param callback
*/
EVHTP_EXPORT void evhtp_callback_free(evhtp_callback_t * callback);
/**
* @brief Adds a evhtp_callback_t to the evhtp_callbacks_t list
*
* @param cbs an allocated evhtp_callbacks_t structure
* @param cb an initialized evhtp_callback_t structure
*
* @return 0 on success, -1 on error
*/
EVHTP_EXPORT int evhtp_callbacks_add_callback(evhtp_callbacks_t * cbs, evhtp_callback_t * cb);
/**
* @brief add an evhtp_t structure (with its own callbacks) to a base evhtp_t
* structure for virtual hosts. It should be noted that if you enable SSL
* on the base evhtp_t and your version of OpenSSL supports SNI, the SNI
* hostname will always take precedence over the Host header value.
*
* @param evhtp
* @param name
* @param vhost
*
* @return
*/
EVHTP_EXPORT int evhtp_add_vhost(evhtp_t * evhtp, const char * name, evhtp_t * vhost);
/**
* @brief Add an alias hostname for a virtual-host specific evhtp_t. This avoids
* having multiple evhtp_t virtual hosts with the same callback for the same
* vhost.
*
* @param evhtp
* @param name
*
* @return
*/
EVHTP_EXPORT int evhtp_add_alias(evhtp_t * evhtp, const char * name);
/**
* @brief Allocates a new key/value structure.