2 * Copyright (c) 2020-2022 Tracey Emery <tracey@traceyemery.net>
3 * Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
4 * Copyright (c) 2013 Florian Obser <florian@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #include <arpa/inet.h>
20 #include <sys/queue.h>
21 #include <sys/socket.h>
22 #include <sys/types.h>
34 #include "got_error.h"
39 size_t fcgi_parse_record(uint8_t *, size_t, struct request *);
40 void fcgi_parse_begin_request(uint8_t *, uint16_t, struct request *,
42 void fcgi_parse_params(uint8_t *, uint16_t, struct request *, uint16_t);
43 int fcgi_send_response(struct request *, int, const void *, size_t);
45 void dump_fcgi_record_header(const char *, struct fcgi_record_header *);
46 void dump_fcgi_begin_request_body(const char *,
47 struct fcgi_begin_request_body *);
48 void dump_fcgi_end_request_body(const char *,
49 struct fcgi_end_request_body *);
51 extern int cgi_inflight;
52 extern volatile int client_cnt;
55 fcgi_request(int fd, short events, void *arg)
57 struct request *c = arg;
61 n = read(fd, c->buf + c->buf_pos + c->buf_len,
62 FCGI_RECORD_SIZE - c->buf_pos-c->buf_len);
76 log_debug("closed connection");
85 * Parse the records as they are received. Per the FastCGI
86 * specification, the server need only receive the FastCGI
87 * parameter records in full; it is free to begin execution
88 * at that point, which is what happens here.
91 parsed = fcgi_parse_record(c->buf + c->buf_pos, c->buf_len, c);
96 } while (parsed > 0 && c->buf_len > 0);
98 /* Make space for further reads */
100 if (c->buf_len > 0) {
101 bcopy(c->buf + c->buf_pos, c->buf, c->buf_len);
106 fcgi_cleanup_request(c);
110 fcgi_parse_record(uint8_t *buf, size_t n, struct request *c)
112 struct fcgi_record_header *h;
114 if (n < sizeof(struct fcgi_record_header))
117 h = (struct fcgi_record_header*) buf;
119 dump_fcgi_record("", h);
121 if (n < sizeof(struct fcgi_record_header) + ntohs(h->content_len)
126 log_warn("wrong version");
129 case FCGI_BEGIN_REQUEST:
130 fcgi_parse_begin_request(buf +
131 sizeof(struct fcgi_record_header),
132 ntohs(h->content_len), c, ntohs(h->id));
135 fcgi_parse_params(buf + sizeof(struct fcgi_record_header),
136 ntohs(h->content_len), c, ntohs(h->id));
139 case FCGI_ABORT_REQUEST:
140 if (c->sock->client_status != CLIENT_DISCONNECT &&
141 c->outbuf_len != 0) {
142 fcgi_send_response(c, FCGI_STDOUT, c->outbuf,
146 fcgi_create_end_record(c);
147 fcgi_cleanup_request(c);
150 log_warn("unimplemented type %d", h->type);
154 return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
159 fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
160 struct request *c, uint16_t id)
162 /* XXX -- FCGI_CANT_MPX_CONN */
163 if (c->request_started) {
164 log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
168 if (n != sizeof(struct fcgi_begin_request_body)) {
169 log_warn("wrong size %d != %lu", n,
170 sizeof(struct fcgi_begin_request_body));
174 c->request_started = 1;
182 fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
184 struct env_val *env_entry;
185 uint32_t name_len, val_len;
186 uint8_t *sd, *dr_buf;
188 if (!c->request_started) {
189 log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
194 log_warn("unexpected id, ignoring");
199 gotweb_process_request(c);
204 if (buf[0] >> 7 == 0) {
210 name_len = ((buf[0] & 0x7f) << 24) +
211 (buf[1] << 16) + (buf[2] << 8) + buf[3];
219 if (buf[0] >> 7 == 0) {
225 val_len = ((buf[0] & 0x7f) << 24) +
226 (buf[1] << 16) + (buf[2] << 8) +
236 if (n < name_len + val_len)
239 if ((env_entry = malloc(sizeof(struct env_val))) == NULL) {
240 log_warn("cannot malloc env_entry");
244 if ((env_entry->val = calloc(sizeof(char), name_len + val_len +
246 log_warn("cannot allocate env_entry->val");
251 bcopy(buf, env_entry->val, name_len);
255 env_entry->val[name_len] = '\0';
256 if (val_len < MAX_QUERYSTRING && strcmp(env_entry->val,
257 "QUERY_STRING") == 0 && c->querystring[0] == '\0') {
258 bcopy(buf, c->querystring, val_len);
259 c->querystring[val_len] = '\0';
261 if (val_len < GOTWEBD_MAXTEXT && strcmp(env_entry->val,
262 "HTTP_HOST") == 0 && c->http_host[0] == '\0') {
265 * lazily get subdomain
266 * will only get domain if no subdomain exists
267 * this can still work if gotweb server name is the same
269 sd = strchr(buf, '.');
273 bcopy(buf, c->http_host, val_len);
274 c->http_host[val_len] = '\0';
276 if (val_len < MAX_DOCUMENT_ROOT && strcmp(env_entry->val,
277 "DOCUMENT_ROOT") == 0 && c->document_root[0] == '\0') {
279 /* drop first char, as it's always / */
282 bcopy(dr_buf, c->document_root, val_len - 1);
283 c->document_root[val_len] = '\0';
285 if (val_len < MAX_SERVER_NAME && strcmp(env_entry->val,
286 "SERVER_NAME") == 0 && c->server_name[0] == '\0') {
287 /* drop first char, as it's always / */
289 bcopy(buf, c->server_name, val_len);
290 c->server_name[val_len] = '\0';
292 env_entry->val[name_len] = '=';
294 bcopy(buf, (env_entry->val) + name_len + 1, val_len);
298 SLIST_INSERT_HEAD(&c->env, env_entry, entry);
299 log_debug("env[%d], %s", c->env_count, env_entry->val);
305 fcgi_timeout(int fd, short events, void *arg)
307 fcgi_cleanup_request((struct request*) arg);
311 fcgi_gen_binary_response(struct request *c, const uint8_t *data, int len)
315 if (c->sock->client_status == CLIENT_DISCONNECT)
318 if (data == NULL || len == 0)
322 * special case: send big replies -like blobs- directly
325 if (len > sizeof(c->outbuf)) {
326 if (c->outbuf_len > 0) {
327 fcgi_send_response(c, FCGI_STDOUT,
328 c->outbuf, c->outbuf_len);
331 return fcgi_send_response(c, FCGI_STDOUT, data, len);
334 if (len < sizeof(c->outbuf) - c->outbuf_len) {
335 memcpy(c->outbuf + c->outbuf_len, data, len);
336 c->outbuf_len += len;
340 r = fcgi_send_response(c, FCGI_STDOUT, c->outbuf, c->outbuf_len);
344 memcpy(c->outbuf, data, len);
350 fcgi_gen_response(struct request *c, const char *data)
352 if (data == NULL || *data == '\0')
354 return fcgi_gen_binary_response(c, data, strlen(data));
358 send_response(struct request *c, int type, const uint8_t *data,
361 static const uint8_t padding[FCGI_PADDING_SIZE];
362 struct fcgi_record_header header;
366 size_t padded_len, tot;
367 int i, err = 0, th = 2000;
372 memset(&header, 0, sizeof(header));
375 header.id = htons(c->id);
376 header.content_len = htons(len);
378 /* The FastCGI spec suggests to align the output buffer */
379 tot = sizeof(header) + len;
380 padded_len = FCGI_ALIGN(tot);
381 if (padded_len > tot) {
382 header.padding_len = padded_len - tot;
383 tot += header.padding_len;
386 iov[0].iov_base = &header;
387 iov[0].iov_len = sizeof(header);
389 iov[1].iov_base = (void *)data;
390 iov[1].iov_len = len;
392 iov[2].iov_base = (void *)padding;
393 iov[2].iov_len = header.padding_len;
395 dump_fcgi_record("resp ", &header);
398 * XXX: add some simple write heuristics here
399 * On slower VMs, spotty connections, etc., we don't want to go right to
400 * disconnect. Let's at least try to write the data a few times before
404 nw = writev(c->fd, iov, nitems(iov));
406 c->sock->client_status = CLIENT_DISCONNECT;
411 if (errno == EAGAIN && err < th) {
412 nanosleep(&ts, NULL);
415 log_warn("%s: write failure", __func__);
416 c->sock->client_status = CLIENT_DISCONNECT;
421 log_debug("%s: partial write: %zu vs %zu", __func__,
425 for (i = 0; i < nitems(iov); ++i) {
426 if (nw < iov[i].iov_len) {
427 iov[i].iov_base += nw;
428 iov[i].iov_len -= nw;
431 nw -= iov[i].iov_len;
440 fcgi_send_response(struct request *c, int type, const void *data,
443 if (c->sock->client_status == CLIENT_DISCONNECT)
446 while (len > FCGI_CONTENT_SIZE) {
447 if (send_response(c, type, data, len) == -1)
450 data += FCGI_CONTENT_SIZE;
451 len -= FCGI_CONTENT_SIZE;
457 return send_response(c, type, data, len);
461 fcgi_create_end_record(struct request *c)
463 struct fcgi_end_request_body end_request;
465 memset(&end_request, 0, sizeof(end_request));
466 end_request.app_status = htonl(0); /* script status */
467 end_request.protocol_status = FCGI_REQUEST_COMPLETE;
469 fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
470 sizeof(end_request));
474 fcgi_cleanup_request(struct request *c)
479 evtimer_del(&c->tmo);
480 if (event_initialized(&c->ev))
484 gotweb_free_transport(c->t);
489 dump_fcgi_record(const char *p, struct fcgi_record_header *h)
491 dump_fcgi_record_header(p, h);
493 if (h->type == FCGI_BEGIN_REQUEST)
494 dump_fcgi_begin_request_body(p,
495 (struct fcgi_begin_request_body *)(h + 1));
496 else if (h->type == FCGI_END_REQUEST)
497 dump_fcgi_end_request_body(p,
498 (struct fcgi_end_request_body *)(h + 1));
502 dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
504 log_debug("%sversion: %d", p, h->version);
505 log_debug("%stype: %d", p, h->type);
506 log_debug("%srequestId: %d", p, ntohs(h->id));
507 log_debug("%scontentLength: %d", p, ntohs(h->content_len));
508 log_debug("%spaddingLength: %d", p, h->padding_len);
509 log_debug("%sreserved: %d", p, h->reserved);
513 dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
515 log_debug("%srole %d", p, ntohs(b->role));
516 log_debug("%sflags %d", p, b->flags);
520 dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
522 log_debug("%sappStatus: %d", p, ntohl(b->app_status));
523 log_debug("%sprotocolStatus: %d", p, b->protocol_status);