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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
|
#include "first.h"
#include "base.h"
#include "stat_cache.h"
#include "http_kv.h"
#include "fdlog.h"
#include "log.h"
#include "response.h"
#include "http_cgi.h"
#include "http_chunk.h"
#include "http_header.h"
#include "plugin.h"
#include <sys/types.h>
#include "sys-socket.h"
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif
#include <unistd.h>
#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <fdevent.h>
#include <fcntl.h>
#include <signal.h>
typedef struct {
uintptr_t *offsets;
size_t osize;
size_t oused;
buffer *b;
buffer *boffsets;
buffer *ld_preload;
buffer *ld_library_path;
#ifdef __CYGWIN__
buffer *systemroot;
#endif
} env_accum;
typedef struct {
unix_time64_t read_timeout;
unix_time64_t write_timeout;
int signal_fin;
} cgi_limits;
typedef struct {
const array *cgi;
const cgi_limits *limits;
unsigned short execute_x_only;
unsigned short local_redir;
unsigned short xsendfile_allow;
unsigned short upgrade;
const array *xsendfile_docroot;
} plugin_config;
struct cgi_pid_t;
typedef struct {
PLUGIN_DATA;
plugin_config defaults;
plugin_config conf;
int tempfile_accum;
struct cgi_pid_t *cgi_pid;
env_accum env;
} plugin_data;
typedef struct {
struct cgi_pid_t *cgi_pid;
int fd;
int fdtocgi;
int rd_revents;
int wr_revents;
fdnode *fdn;
fdnode *fdntocgi;
request_st *r;
connection *con; /* dumb pointer */
struct fdevents *ev; /* dumb pointer */
plugin_data *plugin_data; /* dumb pointer */
buffer *response;
unix_time64_t read_ts;
unix_time64_t write_ts;
buffer *cgi_handler; /* dumb pointer */
http_response_opts opts;
plugin_config conf;
off_t orig_reqbody_length;
} handler_ctx;
typedef struct cgi_pid_t {
pid_t pid;
int signal_sent;
handler_ctx *hctx;
struct cgi_pid_t *next;
struct cgi_pid_t *prev;
} cgi_pid_t;
static handler_ctx * cgi_handler_ctx_init(void) {
handler_ctx *hctx = ck_calloc(1, sizeof(*hctx));
hctx->response = chunk_buffer_acquire();
hctx->fd = -1;
hctx->fdtocgi = -1;
return hctx;
}
static void cgi_handler_ctx_free(handler_ctx *hctx) {
chunk_buffer_release(hctx->response);
free(hctx);
}
INIT_FUNC(mod_cgi_init) {
plugin_data * const p = ck_calloc(1, sizeof(*p));
const char *s;
/* for valgrind */
s = getenv("LD_PRELOAD");
if (s) buffer_copy_string((p->env.ld_preload = buffer_init()), s);
s = getenv("LD_LIBRARY_PATH");
if (s) buffer_copy_string((p->env.ld_library_path = buffer_init()), s);
#ifdef __CYGWIN__
/* CYGWIN needs SYSTEMROOT */
s = getenv("SYSTEMROOT");
if (s) buffer_copy_string((p->env.systemroot = buffer_init()), s);
#endif
return p;
}
FREE_FUNC(mod_cgi_free) {
plugin_data *p = p_d;
buffer_free(p->env.ld_preload);
buffer_free(p->env.ld_library_path);
#ifdef __CYGWIN__
buffer_free(p->env.systemroot);
#endif
for (cgi_pid_t *cgi_pid = p->cgi_pid, *next; cgi_pid; cgi_pid = next) {
next = cgi_pid->next;
free(cgi_pid);
}
if (NULL == p->cvlist) return;
/* (init i to 0 if global context; to 1 to skip empty global context) */
for (int i = !p->cvlist[0].v.u2[1], used = p->nconfig; i < used; ++i) {
config_plugin_value_t *cpv = p->cvlist + p->cvlist[i].v.u2[0];
for (; -1 != cpv->k_id; ++cpv) {
if (cpv->vtype != T_CONFIG_LOCAL || NULL == cpv->v.v) continue;
switch (cpv->k_id) {
case 6: /* cgi.limits */
free(cpv->v.v);
break;
default:
break;
}
}
}
}
static void mod_cgi_merge_config_cpv(plugin_config * const pconf, const config_plugin_value_t * const cpv) {
switch (cpv->k_id) { /* index into static config_plugin_keys_t cpk[] */
case 0: /* cgi.assign */
pconf->cgi = cpv->v.a;
break;
case 1: /* cgi.execute-x-only */
pconf->execute_x_only = (unsigned short)cpv->v.u;
break;
case 2: /* cgi.x-sendfile */
pconf->xsendfile_allow = (unsigned short)cpv->v.u;
break;
case 3: /* cgi.x-sendfile-docroot */
pconf->xsendfile_docroot = cpv->v.a;
break;
case 4: /* cgi.local-redir */
pconf->local_redir = (unsigned short)cpv->v.u;
break;
case 5: /* cgi.upgrade */
pconf->upgrade = (unsigned short)cpv->v.u;
break;
case 6: /* cgi.limits */
if (cpv->vtype != T_CONFIG_LOCAL) break;
pconf->limits = cpv->v.v;
break;
default:/* should not happen */
return;
}
}
static void mod_cgi_merge_config(plugin_config * const pconf, const config_plugin_value_t *cpv) {
do {
mod_cgi_merge_config_cpv(pconf, cpv);
} while ((++cpv)->k_id != -1);
}
static void mod_cgi_patch_config(request_st * const r, plugin_data * const p) {
p->conf = p->defaults; /* copy small struct instead of memcpy() */
/*memcpy(&p->conf, &p->defaults, sizeof(plugin_config));*/
for (int i = 1, used = p->nconfig; i < used; ++i) {
if (config_check_cond(r, (uint32_t)p->cvlist[i].k_id))
mod_cgi_merge_config(&p->conf, p->cvlist + p->cvlist[i].v.u2[0]);
}
}
__attribute_cold__
__attribute_pure__
static int mod_cgi_str_to_signal (const char *s, int default_sig) {
static const struct { const char *name; int sig; } sigs[] = {
{ "HUP", SIGHUP }
,{ "INT", SIGINT }
,{ "QUIT", SIGQUIT }
,{ "ILL", SIGILL }
,{ "TRAP", SIGTRAP }
,{ "ABRT", SIGABRT }
#ifdef SIGBUS
,{ "BUS", SIGBUS }
#endif
,{ "FPE", SIGFPE }
,{ "KILL", SIGKILL }
#ifdef SIGUSR1
,{ "USR1", SIGUSR1 }
#endif
,{ "SEGV", SIGSEGV }
#ifdef SIGUSR2
,{ "USR2", SIGUSR2 }
#endif
,{ "PIPE", SIGPIPE }
,{ "ALRM", SIGALRM }
,{ "TERM", SIGTERM }
#ifdef SIGCHLD
,{ "CHLD", SIGCHLD }
#endif
#ifdef SIGCONT
,{ "CONT", SIGCONT }
#endif
#ifdef SIGURG
,{ "URG", SIGURG }
#endif
#ifdef SIGXCPU
,{ "XCPU", SIGXCPU }
#endif
#ifdef SIGXFSZ
,{ "XFSZ", SIGXFSZ }
#endif
#ifdef SIGWINCH
,{ "WINCH",SIGWINCH}
#endif
#ifdef SIGPOLL
,{ "POLL", SIGPOLL }
#endif
#ifdef SIGIO
,{ "IO", SIGIO }
#endif
};
if (s[0] == 'S' && s[1] == 'I' && s[2] == 'G') s += 3; /*("SIG" prefix)*/
for (uint32_t i = 0; i < sizeof(sigs)/sizeof(*sigs); ++i) {
if (0 == strcmp(s, sigs[i].name)) return sigs[i].sig;
}
return default_sig;
}
static cgi_limits * mod_cgi_parse_limits(const array * const a, log_error_st * const errh) {
cgi_limits * const limits = ck_calloc(1, sizeof(cgi_limits));
for (uint32_t i = 0; i < a->used; ++i) {
const data_unset * const du = a->data[i];
int32_t v = config_plugin_value_to_int32(du, -1);
if (buffer_eq_icase_slen(&du->key, CONST_STR_LEN("read-timeout"))) {
limits->read_timeout = (unix_time64_t)v;
continue;
}
if (buffer_eq_icase_slen(&du->key, CONST_STR_LEN("write-timeout"))) {
limits->write_timeout = (unix_time64_t)v;
continue;
}
if (buffer_eq_icase_slen(&du->key, CONST_STR_LEN("tcp-fin-propagate"))) {
if (-1 == v) {
v = SIGTERM;
if (du->type == TYPE_STRING) {
buffer * const vstr = &((data_string *)du)->value;
buffer_to_upper(vstr);
v = mod_cgi_str_to_signal(vstr->ptr, SIGTERM);
}
}
limits->signal_fin = v;
continue;
}
log_error(errh, __FILE__, __LINE__,
"unrecognized cgi.limits param: %s", du->key.ptr);
}
return limits;
}
SETDEFAULTS_FUNC(mod_cgi_set_defaults) {
static const config_plugin_keys_t cpk[] = {
{ CONST_STR_LEN("cgi.assign"),
T_CONFIG_ARRAY_KVSTRING,
T_CONFIG_SCOPE_CONNECTION }
,{ CONST_STR_LEN("cgi.execute-x-only"),
T_CONFIG_BOOL,
T_CONFIG_SCOPE_CONNECTION }
,{ CONST_STR_LEN("cgi.x-sendfile"),
T_CONFIG_BOOL,
T_CONFIG_SCOPE_CONNECTION }
,{ CONST_STR_LEN("cgi.x-sendfile-docroot"),
T_CONFIG_ARRAY_VLIST,
T_CONFIG_SCOPE_CONNECTION }
,{ CONST_STR_LEN("cgi.local-redir"),
T_CONFIG_BOOL,
T_CONFIG_SCOPE_CONNECTION }
,{ CONST_STR_LEN("cgi.upgrade"),
T_CONFIG_BOOL,
T_CONFIG_SCOPE_CONNECTION }
,{ CONST_STR_LEN("cgi.limits"),
T_CONFIG_ARRAY_KVANY,
T_CONFIG_SCOPE_CONNECTION }
,{ NULL, 0,
T_CONFIG_UNSET,
T_CONFIG_SCOPE_UNSET }
};
plugin_data * const p = p_d;
if (!config_plugin_values_init(srv, p, cpk, "mod_cgi"))
return HANDLER_ERROR;
/* process and validate config directives
* (init i to 0 if global context; to 1 to skip empty global context) */
for (int i = !p->cvlist[0].v.u2[1]; i < p->nconfig; ++i) {
config_plugin_value_t *cpv = p->cvlist + p->cvlist[i].v.u2[0];
for (; -1 != cpv->k_id; ++cpv) {
switch (cpv->k_id) {
case 0: /* cgi.assign */
case 1: /* cgi.execute-x-only */
case 2: /* cgi.x-sendfile */
break;
case 3: /* cgi.x-sendfile-docroot */
for (uint32_t j = 0; j < cpv->v.a->used; ++j) {
data_string *ds = (data_string *)cpv->v.a->data[j];
if (ds->value.ptr[0] != '/') {
log_error(srv->errh, __FILE__, __LINE__,
"%s paths must begin with '/'; invalid: \"%s\"",
cpk[cpv->k_id].k, ds->value.ptr);
return HANDLER_ERROR;
}
buffer_path_simplify(&ds->value);
buffer_append_slash(&ds->value);
}
break;
case 4: /* cgi.local-redir */
case 5: /* cgi.upgrade */
break;
case 6: /* cgi.limits */
cpv->v.v = mod_cgi_parse_limits(cpv->v.a, srv->errh);
if (NULL == cpv->v.v) return HANDLER_ERROR;
cpv->vtype = T_CONFIG_LOCAL;
break;
default:/* should not happen */
break;
}
}
}
/* initialize p->defaults from global config context */
if (p->nconfig > 0 && p->cvlist->v.u2[1]) {
const config_plugin_value_t *cpv = p->cvlist + p->cvlist->v.u2[0];
if (-1 != cpv->k_id)
mod_cgi_merge_config(&p->defaults, cpv);
}
p->tempfile_accum = config_feature_bool(srv, "cgi.tempfile-accum", 1);
return HANDLER_GO_ON;
}
static cgi_pid_t * cgi_pid_add(plugin_data *p, pid_t pid, handler_ctx *hctx) {
cgi_pid_t *cgi_pid = ck_malloc(sizeof(cgi_pid_t));
cgi_pid->pid = pid;
cgi_pid->signal_sent = 0;
cgi_pid->hctx = hctx;
cgi_pid->prev = NULL;
cgi_pid->next = p->cgi_pid;
p->cgi_pid = cgi_pid;
return cgi_pid;
}
static void cgi_pid_kill(cgi_pid_t *cgi_pid, int sig) {
cgi_pid->signal_sent = sig; /*(save last signal sent)*/
kill(cgi_pid->pid, sig);
}
static void cgi_pid_del(plugin_data *p, cgi_pid_t *cgi_pid) {
if (cgi_pid->prev)
cgi_pid->prev->next = cgi_pid->next;
else
p->cgi_pid = cgi_pid->next;
if (cgi_pid->next)
cgi_pid->next->prev = cgi_pid->prev;
free(cgi_pid);
}
static void cgi_connection_close_fdtocgi(handler_ctx *hctx) {
/*(closes only hctx->fdtocgi)*/
if (-1 == hctx->fdtocgi) return;
struct fdevents * const ev = hctx->ev;
fdevent_fdnode_event_del(ev, hctx->fdntocgi);
/*fdevent_unregister(ev, hctx->fdntocgi);*//*(handled below)*/
fdevent_sched_close(ev, hctx->fdntocgi);
hctx->fdntocgi = NULL;
hctx->fdtocgi = -1;
}
static void cgi_connection_close(handler_ctx *hctx) {
/* the connection to the browser went away, but we still have a connection
* to the CGI script
*
* close cgi-connection
*/
if (hctx->fd != -1) {
struct fdevents * const ev = hctx->ev;
/* close connection to the cgi-script */
fdevent_fdnode_event_del(ev, hctx->fdn);
/*fdevent_unregister(ev, hctx->fdn);*//*(handled below)*/
fdevent_sched_close(ev, hctx->fdn);
hctx->fdn = NULL;
}
if (hctx->fdtocgi != -1) {
cgi_connection_close_fdtocgi(hctx); /*(closes only hctx->fdtocgi)*/
}
plugin_data * const p = hctx->plugin_data;
request_st * const r = hctx->r;
r->plugin_ctx[p->id] = NULL;
if (hctx->cgi_pid) {
cgi_pid_kill(hctx->cgi_pid, SIGTERM);
hctx->cgi_pid->hctx = NULL;
}
cgi_handler_ctx_free(hctx);
/* finish response (if not already r->resp_body_started, r->resp_body_finished) */
if (r->handler_module == p->self) {
http_response_backend_done(r);
}
}
static handler_t cgi_connection_close_callback(request_st * const r, void *p_d) {
handler_ctx *hctx = r->plugin_ctx[((plugin_data *)p_d)->id];
if (hctx) {
chunkqueue_set_tempdirs(&r->reqbody_queue, /* reset sz */
r->reqbody_queue.tempdirs, 0);
cgi_connection_close(hctx);
}
return HANDLER_GO_ON;
}
static int cgi_write_request(handler_ctx *hctx, int fd);
static handler_t cgi_handle_fdevent_send (void *ctx, int revents) {
handler_ctx *hctx = ctx;
hctx->wr_revents |= revents;
joblist_append(hctx->con);
return HANDLER_FINISHED;
}
static handler_t cgi_process_wr_revents (handler_ctx * const hctx, request_st * const r, int revents) {
if (revents & FDEVENT_OUT) {
if (0 != cgi_write_request(hctx, hctx->fdtocgi)) {
cgi_connection_close(hctx);
return HANDLER_ERROR;
}
/* more request body to be sent to CGI */
}
if (revents & FDEVENT_HUP) {
/* skip sending remaining data to CGI */
if (r->reqbody_length) {
chunkqueue *cq = &r->reqbody_queue;
chunkqueue_mark_written(cq, chunkqueue_length(cq));
if (cq->bytes_in != (off_t)r->reqbody_length) {
r->keep_alive = 0;
}
}
cgi_connection_close_fdtocgi(hctx); /*(closes only hctx->fdtocgi)*/
} else if (revents & FDEVENT_ERR) {
/* kill all connections to the cgi process */
#if 1
log_error(r->conf.errh, __FILE__, __LINE__, "cgi-FDEVENT_ERR");
#endif
cgi_connection_close(hctx);
return HANDLER_ERROR;
}
return HANDLER_GO_ON;
}
static handler_t cgi_response_headers(request_st * const r, struct http_response_opts_t *opts) {
/* response headers just completed */
handler_ctx *hctx = (handler_ctx *)opts->pdata;
if (light_btst(r->resp_htags, HTTP_HEADER_UPGRADE)) {
if (hctx->conf.upgrade && r->http_status == 101) {
/* 101 Switching Protocols; transition to transparent proxy */
if (r->h2_connect_ext) {
r->http_status = 200; /* OK (response status for CONNECT) */
http_header_response_unset(r, HTTP_HEADER_UPGRADE,
CONST_STR_LEN("Upgrade"));
http_header_response_unset(r, HTTP_HEADER_OTHER,
CONST_STR_LEN("Sec-WebSocket-Accept"));
}
http_response_upgrade_read_body_unknown(r);
}
else {
light_bclr(r->resp_htags, HTTP_HEADER_UPGRADE);
#if 0
/* preserve prior questionable behavior; likely broken behavior
* anyway if backend thinks connection is being upgraded but client
* does not receive Connection: upgrade */
http_header_response_unset(r, HTTP_HEADER_UPGRADE,
CONST_STR_LEN("Upgrade"));
#endif
}
}
else if (__builtin_expect( (r->h2_connect_ext != 0), 0)
&& r->http_status < 300) {
/*(not handling other 1xx intermediate responses here; not expected)*/
http_response_body_clear(r, 0);
r->handler_module = NULL;
r->http_status = 405; /* Method Not Allowed */
return HANDLER_FINISHED;
}
if (hctx->conf.upgrade
&& !light_btst(r->resp_htags, HTTP_HEADER_UPGRADE)) {
chunkqueue *cq = &r->reqbody_queue;
hctx->conf.upgrade = 0;
r->reqbody_length = hctx->orig_reqbody_length;
if (cq->bytes_out == (off_t)r->reqbody_length) {
cgi_connection_close_fdtocgi(hctx); /*(closes hctx->fdtocgi)*/
}
}
return HANDLER_GO_ON;
}
__attribute_cold__
__attribute_noinline__
static handler_t cgi_local_redir(request_st * const r, handler_ctx * const hctx) {
buffer_clear(hctx->response);
chunk_buffer_yield(hctx->response);
http_response_reset(r); /*(includes r->http_status = 0)*/
r->con->srv->plugins_request_reset(r);
/*cgi_connection_close(hctx);*//*(already cleaned up and hctx is now invalid)*/
return HANDLER_COMEBACK;
}
static int cgi_recv_response(request_st * const r, handler_ctx * const hctx) {
const off_t bytes_in = r->write_queue.bytes_in;
switch (http_response_read(r, &hctx->opts,
hctx->response, hctx->fdn)) {
default:
if (r->write_queue.bytes_in > bytes_in)
hctx->read_ts = log_monotonic_secs;
return HANDLER_GO_ON;
case HANDLER_ERROR:
http_response_backend_error(r);
__attribute_fallthrough__
case HANDLER_FINISHED:
cgi_connection_close(hctx);
return HANDLER_FINISHED;
case HANDLER_COMEBACK:
return cgi_local_redir(r, hctx); /* HANDLER_COMEBACK */
}
}
static handler_t cgi_handle_fdevent(void *ctx, int revents) {
handler_ctx *hctx = ctx;
hctx->rd_revents |= revents;
joblist_append(hctx->con);
return HANDLER_FINISHED;
}
static handler_t cgi_process_rd_revents(handler_ctx * const hctx, request_st * const r, int revents) {
if (revents & FDEVENT_IN) {
handler_t rc = cgi_recv_response(r, hctx); /*(might invalidate hctx)*/
if (rc != HANDLER_GO_ON) return rc; /*(unless HANDLER_GO_ON)*/
}
/* perhaps this issue is already handled */
if (revents & (FDEVENT_HUP|FDEVENT_RDHUP)) {
if (r->resp_body_started) {
/* drain any remaining data from kernel pipe buffers
* even if (r->conf.stream_response_body
* & FDEVENT_STREAM_RESPONSE_BUFMIN)
* since event loop will spin on fd FDEVENT_HUP event
* until unregistered. */
handler_t rc;
const unsigned short flags = r->conf.stream_response_body;
r->conf.stream_response_body &= ~FDEVENT_STREAM_RESPONSE_BUFMIN;
r->conf.stream_response_body |= FDEVENT_STREAM_RESPONSE_POLLRDHUP;
do {
rc = cgi_recv_response(r,hctx); /*(might invalidate hctx)*/
} while (rc == HANDLER_GO_ON); /*(unless HANDLER_GO_ON)*/
r->conf.stream_response_body = flags;
return rc; /* HANDLER_FINISHED or HANDLER_COMEBACK or HANDLER_ERROR */
} else if (!buffer_is_blank(hctx->response)) {
/* unfinished header package which is a body in reality */
r->resp_body_started = 1;
if (0 != http_chunk_append_buffer(r, hctx->response)) {
cgi_connection_close(hctx);
return HANDLER_ERROR;
}
if (0 == r->http_status) r->http_status = 200; /* OK */
}
cgi_connection_close(hctx);
return HANDLER_FINISHED;
} else if (revents & FDEVENT_ERR) {
/* kill all connections to the cgi process */
cgi_connection_close(hctx);
return HANDLER_ERROR;
}
return HANDLER_GO_ON;
}
__attribute_cold__
__attribute_noinline__
static void cgi_env_offset_resize(env_accum *env) {
chunk_buffer_prepare_append(env->boffsets, env->boffsets->size*2);
env->offsets = (uintptr_t *)(void *)env->boffsets->ptr;
env->osize = env->boffsets->size/sizeof(*env->offsets);
}
static int cgi_env_add(void *venv, const char *key, size_t key_len, const char *val, size_t val_len) {
env_accum *env = venv;
if (!key || (!val && val_len)) return -1;
if (__builtin_expect( (env->osize == env->oused), 0))
cgi_env_offset_resize(env);
env->offsets[env->oused++] = env->b->used-1;
char * const dst = buffer_extend(env->b, key_len + val_len + 2);
memcpy(dst, key, key_len);
dst[key_len] = '=';
if (val_len) memcpy(dst + key_len + 1, val, val_len);
dst[key_len + 1 + val_len] = '\0';
return 0;
}
static int cgi_write_request(handler_ctx *hctx, int fd) {
request_st * const r = hctx->r;
chunkqueue *cq = &r->reqbody_queue;
chunk *c;
chunkqueue_remove_finished_chunks(cq); /* unnecessary? */
/* old comment: windows doesn't support select() on pipes - wouldn't be easy to fix for all platforms.
*/
for (c = cq->first; c; c = cq->first) {
ssize_t wr = chunkqueue_write_chunk_to_pipe(fd, cq, r->conf.errh);
if (wr > 0) {
hctx->write_ts = log_monotonic_secs;
chunkqueue_mark_written(cq, wr);
/* continue if wrote whole chunk or wrote 16k block
* (see chunkqueue_write_chunk_file_intermed()) */
if (c != cq->first || wr == 16384)
continue;
/*(else partial write)*/
}
else if (wr < 0) {
switch(errno) {
case EAGAIN:
case EINTR:
/* ignore and try again later */
break;
case EPIPE:
case ECONNRESET:
/* connection closed */
log_error(r->conf.errh, __FILE__, __LINE__,
"failed to send post data to cgi, connection closed by CGI");
/* skip all remaining data */
chunkqueue_mark_written(cq, chunkqueue_length(cq));
break;
default:
/* fatal error */
log_perror(r->conf.errh, __FILE__, __LINE__, "write() failed");
return -1;
}
}
/*if (0 == wr) break;*/ /*(might block)*/
break;
}
if (cq->bytes_out == (off_t)r->reqbody_length && !hctx->conf.upgrade) {
/* sent all request body input */
/* close connection to the cgi-script */
if (-1 == hctx->fdtocgi) { /*(received request body sent in initial send to pipe buffer)*/
--r->con->srv->cur_fds;
if (close(fd)) {
log_perror(r->conf.errh, __FILE__, __LINE__, "cgi stdin close %d failed", fd);
}
} else {
cgi_connection_close_fdtocgi(hctx); /*(closes only hctx->fdtocgi)*/
}
} else {
off_t cqlen = chunkqueue_length(cq);
if (cq->bytes_in != r->reqbody_length && cqlen < 65536 - 16384) {
/*(r->conf.stream_request_body & FDEVENT_STREAM_REQUEST)*/
if (!(r->conf.stream_request_body & FDEVENT_STREAM_REQUEST_POLLIN)) {
r->conf.stream_request_body |= FDEVENT_STREAM_REQUEST_POLLIN;
if (r->http_version <= HTTP_VERSION_1_1)
r->con->is_readable = 1;/* trigger optimistic client read */
}
}
struct fdevents * const ev = hctx->ev;
if (-1 == hctx->fdtocgi) { /*(not registered yet)*/
hctx->fdtocgi = fd;
hctx->fdntocgi = fdevent_register(ev, hctx->fdtocgi, cgi_handle_fdevent_send, hctx);
}
if (0 == cqlen) { /*(chunkqueue_is_empty(cq))*/
if ((fdevent_fdnode_interest(hctx->fdntocgi) & FDEVENT_OUT)) {
fdevent_fdnode_event_set(ev, hctx->fdntocgi, 0);
}
} else {
/* more request body remains to be sent to CGI so register for fdevents */
hctx->write_ts = log_monotonic_secs;
fdevent_fdnode_event_set(ev, hctx->fdntocgi, FDEVENT_OUT);
}
}
return 0;
}
static int cgi_create_env(request_st * const r, plugin_data * const p, handler_ctx * const hctx, buffer * const cgi_handler) {
char *args[3];
int to_cgi_fds[2];
int from_cgi_fds[2];
UNUSED(p);
if (!buffer_is_blank(cgi_handler)) {
if (NULL == stat_cache_path_stat(cgi_handler)) {
log_perror(r->conf.errh, __FILE__, __LINE__,
"stat for cgi-handler %s", cgi_handler->ptr);
return -1;
}
}
to_cgi_fds[0] = -1;
if (0 == r->reqbody_length) {
/* future: might keep fd open in p->devnull for reuse
* and dup() here, or do not close() (later in this func) */
to_cgi_fds[0] = fdevent_open_devnull();
if (-1 == to_cgi_fds[0]) {
log_perror(r->conf.errh, __FILE__, __LINE__, "open /dev/null");
return -1;
}
}
else if (!(r->conf.stream_request_body /*(if not streaming request body)*/
& (FDEVENT_STREAM_REQUEST|FDEVENT_STREAM_REQUEST_BUFMIN))
&& !hctx->conf.upgrade) {
chunkqueue * const cq = &r->reqbody_queue;
chunk * const c = cq->first;
if (c && c == cq->last && c->type == FILE_CHUNK && c->file.is_temp) {
/* request body in single tempfile if not streaming req body */
if (-1 == c->file.fd
&& 0 != chunkqueue_open_file_chunk(cq, r->conf.errh))
return -1;
#ifdef __COVERITY__
force_assert(-1 != c->file.fd);
#endif
if (-1 == lseek(c->file.fd, 0, SEEK_SET)) {
log_perror(r->conf.errh, __FILE__, __LINE__,
"lseek %s", c->mem->ptr);
return -1;
}
to_cgi_fds[0] = c->file.fd;
to_cgi_fds[1] = -1;
}
}
unsigned int bufsz_hint = 16384;
#ifdef _WIN32
if (r->reqbody_length <= 1048576 && r->reqbody_length > 0)
bufsz_hint = (unsigned int)r->reqbody_length;
#endif
if (-1 == to_cgi_fds[0] && fdevent_pipe_cloexec(to_cgi_fds, bufsz_hint)) {
log_perror(r->conf.errh, __FILE__, __LINE__, "pipe failed");
return -1;
}
if (fdevent_pipe_cloexec(from_cgi_fds, bufsz_hint)) {
if (0 == r->reqbody_length) {
close(to_cgi_fds[0]);
}
else if (-1 != to_cgi_fds[1]) {
close(to_cgi_fds[0]);
close(to_cgi_fds[1]);
}
log_perror(r->conf.errh, __FILE__, __LINE__, "pipe failed");
return -1;
}
env_accum * const env = &p->env;
env->b = chunk_buffer_acquire();
env->boffsets = chunk_buffer_acquire();
buffer_truncate(env->b, 0);
char **envp;
{
size_t i = 0;
http_cgi_opts opts = { 0, 0, NULL, NULL };
env->offsets = (uintptr_t *)(void *)env->boffsets->ptr;
env->osize = env->boffsets->size/sizeof(*env->offsets);
env->oused = 0;
/* create environment */
http_version_t http_version = r->http_version;
if (r->h2_connect_ext) {
/*(SERVER_PROTOCOL=HTTP/1.1 instead of HTTP/2.0)*/
r->http_version = HTTP_VERSION_1_1;
r->http_method = HTTP_METHOD_GET;
}
if (hctx->conf.upgrade) {
r->reqbody_length = hctx->orig_reqbody_length;
if (r->reqbody_length < 0)
r->reqbody_length = 0;
}
http_cgi_headers(r, &opts, cgi_env_add, env);
if (hctx->conf.upgrade)
r->reqbody_length = -1;
if (r->h2_connect_ext) {
r->http_version = http_version; /*(restore from above)*/
r->http_method = HTTP_METHOD_CONNECT;
/* https://datatracker.ietf.org/doc/html/rfc6455#section-4.1
* 7. The request MUST include a header field with the name
* |Sec-WebSocket-Key|. The value of this header field MUST be a
* nonce consisting of a randomly selected 16-byte value that has
* been base64-encoded (see Section 4 of [RFC4648]). The nonce
* MUST be selected randomly for each connection.
* Note: Sec-WebSocket-Key is not used in RFC8441;
* include Sec-WebSocket-Key for HTTP/1.1 compatibility;
* !!not random!! base64-encoded "0000000000000000" */
if (!http_header_request_get(r, HTTP_HEADER_OTHER,
CONST_STR_LEN("Sec-WebSocket-Key")))
cgi_env_add(env, CONST_STR_LEN("HTTP_SEC_WEBSOCKET_KEY"),
CONST_STR_LEN("MDAwMDAwMDAwMDAwMDAwMA=="));
/*(Upgrade and Connection should not exist for HTTP/2 request)*/
cgi_env_add(env, CONST_STR_LEN("HTTP_UPGRADE"), CONST_STR_LEN("websocket"));
cgi_env_add(env, CONST_STR_LEN("HTTP_CONNECTION"), CONST_STR_LEN("upgrade"));
}
/* for valgrind */
if (p->env.ld_preload) {
cgi_env_add(env, CONST_STR_LEN("LD_PRELOAD"), BUF_PTR_LEN(p->env.ld_preload));
}
if (p->env.ld_library_path) {
cgi_env_add(env, CONST_STR_LEN("LD_LIBRARY_PATH"), BUF_PTR_LEN(p->env.ld_library_path));
}
#ifdef __CYGWIN__
/* CYGWIN needs SYSTEMROOT */
if (p->env.systemroot) {
cgi_env_add(env, CONST_STR_LEN("SYSTEMROOT"), BUF_PTR_LEN(p->env.systemroot));
}
#endif
/* adjust (uintptr_t) offsets to (char *) ptr
* (stored as offsets while accumulating in buffer,
* in case buffer is reallocated during env creation) */
if (__builtin_expect( (env->osize == env->oused), 0))
cgi_env_offset_resize(env);
envp = (char **)env->offsets;
envp[env->oused] = NULL;
const uintptr_t baseptr = (uintptr_t)env->b->ptr;
for (i = 0; i < env->oused; ++i)
envp[i] += baseptr;
/* set up args */
i = 0;
if (!buffer_is_blank(cgi_handler)) {
args[i++] = cgi_handler->ptr;
}
args[i++] = r->physical.path.ptr;
args[i ] = NULL;
}
int dfd = fdevent_open_dirname(r->physical.path.ptr,r->conf.follow_symlink);
if (-1 == dfd) {
log_perror(r->conf.errh, __FILE__, __LINE__, "open dirname %s failed", r->physical.path.ptr);
}
int serrh_fd = r->conf.serrh ? r->conf.serrh->fd : -1;
pid_t pid = (dfd >= 0)
? fdevent_fork_execve(args[0], args, envp,
to_cgi_fds[0], from_cgi_fds[1], serrh_fd, dfd)
: -1;
chunk_buffer_release(env->boffsets);
chunk_buffer_release(env->b);
env->boffsets = NULL;
env->b = NULL;
if (-1 == pid) {
/* log error with errno prior to calling close() (might change errno) */
log_perror(r->conf.errh, __FILE__, __LINE__, "fork failed");
if (-1 != dfd) close(dfd);
close(from_cgi_fds[0]);
close(from_cgi_fds[1]);
if (0 == r->reqbody_length) {
close(to_cgi_fds[0]);
}
else if (-1 != to_cgi_fds[1]) {
close(to_cgi_fds[0]);
close(to_cgi_fds[1]);
}
return -1;
} else {
if (-1 != dfd) close(dfd);
close(from_cgi_fds[1]);
hctx->fd = from_cgi_fds[0];
hctx->cgi_pid = cgi_pid_add(p, pid, hctx);
if (0 == r->reqbody_length) {
close(to_cgi_fds[0]);
}
else if (-1 == to_cgi_fds[1]) {
chunkqueue * const cq = &r->reqbody_queue;
chunkqueue_mark_written(cq, chunkqueue_length(cq));
}
else if (0 == fdevent_fcntl_set_nb(to_cgi_fds[1])
&& 0 == cgi_write_request(hctx, to_cgi_fds[1])) {
close(to_cgi_fds[0]);
++r->con->srv->cur_fds;
}
else {
close(to_cgi_fds[0]);
close(to_cgi_fds[1]);
/*(hctx->fd not yet registered with fdevent, so manually
* cleanup here; see fdevent_register() further below)*/
close(hctx->fd);
hctx->fd = -1;
cgi_connection_close(hctx);
return -1;
}
++r->con->srv->cur_fds;
struct fdevents * const ev = hctx->ev;
hctx->fdn = fdevent_register(ev, hctx->fd, cgi_handle_fdevent, hctx);
if (-1 == fdevent_fcntl_set_nb(hctx->fd)) {
log_perror(r->conf.errh, __FILE__, __LINE__, "fcntl failed");
cgi_connection_close(hctx);
return -1;
}
hctx->read_ts = log_monotonic_secs;
fdevent_fdnode_event_set(ev, hctx->fdn, FDEVENT_IN | FDEVENT_RDHUP);
return 0;
}
}
URIHANDLER_FUNC(cgi_is_handled) {
plugin_data *p = p_d;
const stat_cache_st *st;
data_string *ds;
if (NULL != r->handler_module) return HANDLER_GO_ON;
/* r->physical.path is non-empty for handle_subrequest_start */
/*if (buffer_is_blank(&r->physical.path)) return HANDLER_GO_ON;*/
mod_cgi_patch_config(r, p);
if (NULL == p->conf.cgi) return HANDLER_GO_ON;
ds = (data_string *)array_match_key_suffix(p->conf.cgi, &r->physical.path);
if (NULL == ds) return HANDLER_GO_ON;
/* r->tmp_sce is set in http_response_physical_path_check() and is valid
* in handle_subrequest_start callback -- handle_subrequest_start callbacks
* should not change r->physical.path (or should invalidate r->tmp_sce) */
st = r->tmp_sce && buffer_is_equal(&r->tmp_sce->name, &r->physical.path)
? &r->tmp_sce->st
: stat_cache_path_stat(&r->physical.path);
if (NULL == st) return HANDLER_GO_ON;
/* (aside: CGI might be executable even if it is not readable) */
if (!S_ISREG(st->st_mode)) return HANDLER_GO_ON;
if (p->conf.execute_x_only == 1 && (st->st_mode & (S_IXUSR | S_IXGRP | S_IXOTH)) == 0) return HANDLER_GO_ON;
if (__builtin_expect( (r->h2_connect_ext != 0), 0) && !p->conf.upgrade) {
r->http_status = 405; /* Method Not Allowed */
return HANDLER_FINISHED;
}
if (r->reqbody_length
&& p->tempfile_accum
&& !(r->conf.stream_request_body /*(if not streaming request body)*/
& (FDEVENT_STREAM_REQUEST|FDEVENT_STREAM_REQUEST_BUFMIN))) {
/* store request body in single tempfile if not streaming request body*/
r->reqbody_queue.upload_temp_file_size =
(off_t)((1uLL << (sizeof(off_t)*8-1))-1);
}
{
handler_ctx *hctx = cgi_handler_ctx_init();
hctx->ev = r->con->srv->ev;
hctx->r = r;
hctx->con = r->con;
hctx->plugin_data = p;
hctx->cgi_handler = &ds->value;
memcpy(&hctx->conf, &p->conf, sizeof(plugin_config));
if (__builtin_expect( (r->h2_connect_ext != 0), 0)) {
}
else if (!light_btst(r->rqst_htags, HTTP_HEADER_UPGRADE))
hctx->conf.upgrade = 0;
else if (!hctx->conf.upgrade || r->http_version != HTTP_VERSION_1_1) {
hctx->conf.upgrade = 0;
http_header_request_unset(r, HTTP_HEADER_UPGRADE,
CONST_STR_LEN("Upgrade"));
}
if (hctx->conf.upgrade) {
hctx->orig_reqbody_length = r->reqbody_length;
r->reqbody_length = -1;
}
hctx->opts.max_per_read =
!(r->conf.stream_response_body /*(if not streaming response body)*/
& (FDEVENT_STREAM_RESPONSE|FDEVENT_STREAM_RESPONSE_BUFMIN))
? 262144
: (r->conf.stream_response_body & FDEVENT_STREAM_RESPONSE_BUFMIN)
? 16384 /* FDEVENT_STREAM_RESPONSE_BUFMIN */
: 65536; /* FDEVENT_STREAM_RESPONSE */
hctx->opts.fdfmt = S_IFIFO;
hctx->opts.backend = BACKEND_CGI;
hctx->opts.authorizer = 0;
hctx->opts.local_redir = hctx->conf.local_redir;
hctx->opts.xsendfile_allow = hctx->conf.xsendfile_allow;
hctx->opts.xsendfile_docroot = hctx->conf.xsendfile_docroot;
hctx->opts.pdata = hctx;
hctx->opts.headers = cgi_response_headers;
r->plugin_ctx[p->id] = hctx;
r->handler_module = p->self;
}
return HANDLER_GO_ON;
}
/*
* - HANDLER_GO_ON : not our job
* - HANDLER_FINISHED: got response
* - HANDLER_WAIT_FOR_EVENT: waiting for response
*/
SUBREQUEST_FUNC(mod_cgi_handle_subrequest) {
plugin_data * const p = p_d;
handler_ctx * const hctx = r->plugin_ctx[p->id];
if (NULL == hctx) return HANDLER_GO_ON;
if (__builtin_expect(
(r->conf.stream_request_body & FDEVENT_STREAM_REQUEST_TCP_FIN), 0)
&& hctx->conf.limits && hctx->conf.limits->signal_fin) {
/* XXX: consider setting r->http_status = 499 if (0 == r->http_status)
* (499 is nginx custom status to indicate client closed connection) */
if (-1 == hctx->fd) return HANDLER_ERROR; /*(CGI not yet spawned)*/
if (hctx->cgi_pid) /* send signal to notify CGI about TCP FIN */
cgi_pid_kill(hctx->cgi_pid, hctx->conf.limits->signal_fin);
}
const int rd_revents = hctx->rd_revents;
const int wr_revents = hctx->wr_revents;
if (rd_revents) {
hctx->rd_revents = 0;
handler_t rc = cgi_process_rd_revents(hctx, r, rd_revents);
if (rc != HANDLER_GO_ON) return rc; /*(might invalidate hctx)*/
}
if (wr_revents) {
hctx->wr_revents = 0;
handler_t rc = cgi_process_wr_revents(hctx, r, wr_revents);
if (rc != HANDLER_GO_ON) return rc; /*(might invalidate hctx)*/
}
if ((r->conf.stream_response_body & FDEVENT_STREAM_RESPONSE_BUFMIN)
&& r->resp_body_started) {
if (chunkqueue_length(&r->write_queue) > 65536 - 4096) {
fdevent_fdnode_event_clr(hctx->ev, hctx->fdn, FDEVENT_IN);
} else if (!(fdevent_fdnode_interest(hctx->fdn) & FDEVENT_IN)) {
/* optimistic read from backend */
handler_t rc = cgi_recv_response(r, hctx); /*(might invalidate hctx)*/
if (rc != HANDLER_GO_ON) return rc; /*(unless HANDLER_GO_ON)*/
hctx->read_ts = log_monotonic_secs;
fdevent_fdnode_event_add(hctx->ev, hctx->fdn, FDEVENT_IN);
}
}
chunkqueue * const cq = &r->reqbody_queue;
if (cq->bytes_in != (off_t)r->reqbody_length) {
/*(64k - 4k to attempt to avoid temporary files
* in conjunction with FDEVENT_STREAM_REQUEST_BUFMIN)*/
if (chunkqueue_length(cq) > 65536 - 4096
&& (r->conf.stream_request_body & FDEVENT_STREAM_REQUEST_BUFMIN)){
r->conf.stream_request_body &= ~FDEVENT_STREAM_REQUEST_POLLIN;
} else {
handler_t rc = r->con->reqbody_read(r);
if (rc != HANDLER_GO_ON
&& !(hctx->conf.upgrade && -1 == hctx->fd
&& rc == HANDLER_WAIT_FOR_EVENT))
return rc;
}
}
if (-1 == hctx->fd) {
/* CGI environment requires that Content-Length be set.
* Send 411 Length Required if Content-Length missing.
* (occurs here if client sends Transfer-Encoding: chunked
* and module is flagged to stream request body to backend) */
if (-1 == r->reqbody_length && !hctx->conf.upgrade) {
return (r->conf.stream_request_body & FDEVENT_STREAM_REQUEST)
? http_response_reqbody_read_error(r, 411)
: HANDLER_WAIT_FOR_EVENT;
}
if (cgi_create_env(r, p, hctx, hctx->cgi_handler)) {
r->http_status = 500;
r->handler_module = NULL;
return HANDLER_FINISHED;
}
} else if (!chunkqueue_is_empty(cq)) {
if (fdevent_fdnode_interest(hctx->fdntocgi) & FDEVENT_OUT)
return HANDLER_WAIT_FOR_EVENT;
if (0 != cgi_write_request(hctx, hctx->fdtocgi)) {
cgi_connection_close(hctx);
return HANDLER_ERROR;
}
}
/* if not done, wait for CGI to close stdout, so we read EOF on pipe */
return HANDLER_WAIT_FOR_EVENT;
}
__attribute_cold__
__attribute_noinline__
static void cgi_trigger_hctx_timeout(handler_ctx * const hctx, const char * const msg) {
request_st * const r = hctx->r;
joblist_append(r->con);
log_error(r->conf.errh, __FILE__, __LINE__,
"%s timeout on CGI: %s (pid: %lld)",
msg, r->physical.path.ptr, (long long)hctx->cgi_pid->pid);
if (*msg == 'w') { /* "write" */
/* theoretically, response might be waiting on hctx->fdn pipe
* if it arrived since we last checked for event, and if CGI
* timeout out while reading (or did not read) request body */
handler_t rc = cgi_recv_response(r, hctx); /*(might invalidate hctx)*/
if (rc != HANDLER_GO_ON) return; /*(unless HANDLER_GO_ON)*/
}
if (0 == r->http_status) r->http_status = 504; /* Gateway Timeout */
cgi_connection_close(hctx);
}
static handler_t cgi_trigger_cb(server *srv, void *p_d) {
UNUSED(srv);
const unix_time64_t mono = log_monotonic_secs;
plugin_data * const p = p_d;
for (cgi_pid_t *cgi_pid = p->cgi_pid; cgi_pid; cgi_pid = cgi_pid->next) {
/*(hctx stays in cgi_pid list until process pid is reaped,
* so p->cgi_pid[] is not modified during this loop)*/
handler_ctx * const hctx = cgi_pid->hctx;
if (!hctx) continue; /*(already called cgi_pid_kill())*/
const cgi_limits * const limits = hctx->conf.limits;
if (NULL == limits) continue;
if (limits->read_timeout && hctx->fdn
&& (fdevent_fdnode_interest(hctx->fdn) & FDEVENT_IN)
&& mono - hctx->read_ts > limits->read_timeout) {
cgi_trigger_hctx_timeout(hctx, "read");
continue;
}
if (limits->write_timeout && hctx->fdntocgi
&& (fdevent_fdnode_interest(hctx->fdntocgi) & FDEVENT_OUT)
&& mono - hctx->write_ts > limits->write_timeout) {
cgi_trigger_hctx_timeout(hctx, "write");
continue;
}
}
return HANDLER_GO_ON;
}
static handler_t cgi_waitpid_cb(server *srv, void *p_d, pid_t pid, int status) {
/*(XXX: if supporting a large number of CGI, might use a different algorithm
* instead of linked list, e.g. splaytree indexed with pid)*/
plugin_data *p = (plugin_data *)p_d;
for (cgi_pid_t *cgi_pid = p->cgi_pid; cgi_pid; cgi_pid = cgi_pid->next) {
if (pid != cgi_pid->pid) continue;
handler_ctx * const hctx = cgi_pid->hctx;
if (hctx) hctx->cgi_pid = NULL;
if (WIFEXITED(status)) {
/* (skip logging (non-zero) CGI exit; might be very noisy) */
}
else if (WIFSIGNALED(status)) {
/* ignore SIGTERM if sent by cgi_connection_close() (NULL == hctx)*/
if (WTERMSIG(status) != cgi_pid->signal_sent) {
log_error_st *errh = hctx ? hctx->r->conf.errh : srv->errh;
log_error(errh, __FILE__, __LINE__,
"CGI pid %d died with signal %d", pid, WTERMSIG(status));
}
}
else {
log_error_st *errh = hctx ? hctx->r->conf.errh : srv->errh;
log_error(errh, __FILE__, __LINE__,
"CGI pid %d ended unexpectedly", pid);
}
cgi_pid_del(p, cgi_pid);
return HANDLER_FINISHED;
}
return HANDLER_GO_ON;
}
__attribute_cold__
int mod_cgi_plugin_init(plugin *p);
int mod_cgi_plugin_init(plugin *p) {
p->version = LIGHTTPD_VERSION_ID;
p->name = "cgi";
p->handle_request_reset = cgi_connection_close_callback;
p->handle_subrequest_start = cgi_is_handled;
p->handle_subrequest = mod_cgi_handle_subrequest;
p->handle_trigger = cgi_trigger_cb;
p->handle_waitpid = cgi_waitpid_cb;
p->init = mod_cgi_init;
p->cleanup = mod_cgi_free;
p->set_defaults = mod_cgi_set_defaults;
return 0;
}
|