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 void 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 fcgi_create_end_record(c);
141 fcgi_cleanup_request(c);
144 log_warn("unimplemented type %d", h->type);
148 return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
153 fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
154 struct request *c, uint16_t id)
156 /* XXX -- FCGI_CANT_MPX_CONN */
157 if (c->request_started) {
158 log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
162 if (n != sizeof(struct fcgi_begin_request_body)) {
163 log_warn("wrong size %d != %lu", n,
164 sizeof(struct fcgi_begin_request_body));
168 c->request_started = 1;
176 fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
178 struct env_val *env_entry;
179 uint32_t name_len, val_len;
180 uint8_t *sd, *dr_buf;
182 if (!c->request_started) {
183 log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
188 log_warn("unexpected id, ignoring");
193 gotweb_process_request(c);
198 if (buf[0] >> 7 == 0) {
204 name_len = ((buf[0] & 0x7f) << 24) +
205 (buf[1] << 16) + (buf[2] << 8) + buf[3];
213 if (buf[0] >> 7 == 0) {
219 val_len = ((buf[0] & 0x7f) << 24) +
220 (buf[1] << 16) + (buf[2] << 8) +
230 if (n < name_len + val_len)
233 if ((env_entry = malloc(sizeof(struct env_val))) == NULL) {
234 log_warn("cannot malloc env_entry");
238 if ((env_entry->val = calloc(sizeof(char), name_len + val_len +
240 log_warn("cannot allocate env_entry->val");
245 bcopy(buf, env_entry->val, name_len);
249 env_entry->val[name_len] = '\0';
250 if (val_len < MAX_QUERYSTRING && strcmp(env_entry->val,
251 "QUERY_STRING") == 0 && c->querystring[0] == '\0') {
252 bcopy(buf, c->querystring, val_len);
253 c->querystring[val_len] = '\0';
255 if (val_len < GOTWEBD_MAXTEXT && strcmp(env_entry->val,
256 "HTTP_HOST") == 0 && c->http_host[0] == '\0') {
259 * lazily get subdomain
260 * will only get domain if no subdomain exists
261 * this can still work if gotweb server name is the same
263 sd = strchr(buf, '.');
267 bcopy(buf, c->http_host, val_len);
268 c->http_host[val_len] = '\0';
270 if (val_len < MAX_DOCUMENT_ROOT && strcmp(env_entry->val,
271 "DOCUMENT_ROOT") == 0 && c->document_root[0] == '\0') {
273 /* drop first char, as it's always / */
276 bcopy(dr_buf, c->document_root, val_len - 1);
277 c->document_root[val_len] = '\0';
279 if (val_len < MAX_SERVER_NAME && strcmp(env_entry->val,
280 "SERVER_NAME") == 0 && c->server_name[0] == '\0') {
281 /* drop first char, as it's always / */
283 bcopy(buf, c->server_name, val_len);
284 c->server_name[val_len] = '\0';
286 env_entry->val[name_len] = '=';
288 bcopy(buf, (env_entry->val) + name_len + 1, val_len);
292 SLIST_INSERT_HEAD(&c->env, env_entry, entry);
293 log_debug("env[%d], %s", c->env_count, env_entry->val);
299 fcgi_timeout(int fd, short events, void *arg)
301 fcgi_cleanup_request((struct request*) arg);
305 fcgi_gen_binary_response(struct request *c, const uint8_t *data, int len)
307 if (c->sock->client_status == CLIENT_DISCONNECT)
310 if (data == NULL || len == 0)
313 fcgi_send_response(c, FCGI_STDOUT, data, len);
318 fcgi_gen_response(struct request *c, const char *data)
320 if (data == NULL || *data == '\0')
322 return fcgi_gen_binary_response(c, data, strlen(data));
326 send_response(struct request *c, int type, const uint8_t *data,
329 static const uint8_t padding[FCGI_PADDING_SIZE];
330 struct fcgi_record_header header;
334 size_t padded_len, tot;
335 int i, err = 0, th = 2000;
340 memset(&header, 0, sizeof(header));
343 header.id = htons(c->id);
344 header.content_len = htons(len);
346 /* The FastCGI spec suggests to align the output buffer */
347 tot = sizeof(header) + len;
348 padded_len = FCGI_ALIGN(tot);
349 if (padded_len > tot) {
350 header.padding_len = padded_len - tot;
351 tot += header.padding_len;
354 iov[0].iov_base = &header;
355 iov[0].iov_len = sizeof(header);
357 iov[1].iov_base = (void *)data;
358 iov[1].iov_len = len;
360 iov[2].iov_base = (void *)padding;
361 iov[2].iov_len = header.padding_len;
363 dump_fcgi_record("resp ", &header);
366 * XXX: add some simple write heuristics here
367 * On slower VMs, spotty connections, etc., we don't want to go right to
368 * disconnect. Let's at least try to write the data a few times before
372 nw = writev(c->fd, iov, nitems(iov));
374 c->sock->client_status = CLIENT_DISCONNECT;
379 if (errno == EAGAIN && err < th) {
380 nanosleep(&ts, NULL);
383 log_warn("%s: write failure", __func__);
384 c->sock->client_status = CLIENT_DISCONNECT;
389 log_debug("%s: partial write: %zu vs %zu", __func__,
393 for (i = 0; i < nitems(iov); ++i) {
394 if (nw < iov[i].iov_len) {
395 iov[i].iov_base += nw;
396 iov[i].iov_len -= nw;
399 nw -= iov[i].iov_len;
406 fcgi_send_response(struct request *c, int type, const void *data,
409 while (len > FCGI_CONTENT_SIZE) {
410 send_response(c, type, data, len);
411 if (c->sock->client_status == CLIENT_DISCONNECT)
414 data += FCGI_CONTENT_SIZE;
415 len -= FCGI_CONTENT_SIZE;
421 send_response(c, type, data, len);
425 fcgi_create_end_record(struct request *c)
427 struct fcgi_end_request_body end_request;
429 memset(&end_request, 0, sizeof(end_request));
430 end_request.app_status = htonl(0); /* script status */
431 end_request.protocol_status = FCGI_REQUEST_COMPLETE;
433 fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
434 sizeof(end_request));
438 fcgi_cleanup_request(struct request *c)
443 evtimer_del(&c->tmo);
444 if (event_initialized(&c->ev))
448 gotweb_free_transport(c->t);
453 dump_fcgi_record(const char *p, struct fcgi_record_header *h)
455 dump_fcgi_record_header(p, h);
457 if (h->type == FCGI_BEGIN_REQUEST)
458 dump_fcgi_begin_request_body(p,
459 (struct fcgi_begin_request_body *)(h + 1));
460 else if (h->type == FCGI_END_REQUEST)
461 dump_fcgi_end_request_body(p,
462 (struct fcgi_end_request_body *)(h + 1));
466 dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
468 log_debug("%sversion: %d", p, h->version);
469 log_debug("%stype: %d", p, h->type);
470 log_debug("%srequestId: %d", p, ntohs(h->id));
471 log_debug("%scontentLength: %d", p, ntohs(h->content_len));
472 log_debug("%spaddingLength: %d", p, h->padding_len);
473 log_debug("%sreserved: %d", p, h->reserved);
477 dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
479 log_debug("%srole %d", p, ntohs(b->role));
480 log_debug("%sflags %d", p, b->flags);
484 dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
486 log_debug("%sappStatus: %d", p, ntohl(b->app_status));
487 log_debug("%sprotocolStatus: %d", p, b->protocol_status);