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>
35 #include "got_error.h"
37 #include "got_compat.h"
42 size_t fcgi_parse_record(uint8_t *, size_t, struct request *);
43 void fcgi_parse_begin_request(uint8_t *, uint16_t, struct request *,
45 void fcgi_parse_params(uint8_t *, uint16_t, struct request *, uint16_t);
46 int fcgi_send_response(struct request *, int, const void *, size_t);
48 void dump_fcgi_record_header(const char *, struct fcgi_record_header *);
49 void dump_fcgi_begin_request_body(const char *,
50 struct fcgi_begin_request_body *);
51 void dump_fcgi_end_request_body(const char *,
52 struct fcgi_end_request_body *);
54 extern int cgi_inflight;
55 extern volatile int client_cnt;
58 fcgi_request(int fd, short events, void *arg)
60 struct request *c = arg;
64 n = read(fd, c->buf + c->buf_pos + c->buf_len,
65 FCGI_RECORD_SIZE - c->buf_pos-c->buf_len);
79 log_debug("closed connection");
88 * Parse the records as they are received. Per the FastCGI
89 * specification, the server need only receive the FastCGI
90 * parameter records in full; it is free to begin execution
91 * at that point, which is what happens here.
94 parsed = fcgi_parse_record(c->buf + c->buf_pos, c->buf_len, c);
99 } while (parsed > 0 && c->buf_len > 0);
101 /* Make space for further reads */
103 if (c->buf_len > 0) {
104 bcopy(c->buf + c->buf_pos, c->buf, c->buf_len);
109 fcgi_cleanup_request(c);
113 fcgi_parse_record(uint8_t *buf, size_t n, struct request *c)
115 struct fcgi_record_header *h;
117 if (n < sizeof(struct fcgi_record_header))
120 h = (struct fcgi_record_header*) buf;
122 dump_fcgi_record("", h);
124 if (n < sizeof(struct fcgi_record_header) + ntohs(h->content_len)
129 log_warn("wrong version");
132 case FCGI_BEGIN_REQUEST:
133 fcgi_parse_begin_request(buf +
134 sizeof(struct fcgi_record_header),
135 ntohs(h->content_len), c, ntohs(h->id));
138 fcgi_parse_params(buf + sizeof(struct fcgi_record_header),
139 ntohs(h->content_len), c, ntohs(h->id));
142 case FCGI_ABORT_REQUEST:
143 if (c->sock->client_status != CLIENT_DISCONNECT &&
144 c->outbuf_len != 0) {
145 fcgi_send_response(c, FCGI_STDOUT, c->outbuf,
149 fcgi_create_end_record(c);
150 fcgi_cleanup_request(c);
153 log_warn("unimplemented type %d", h->type);
157 return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
162 fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
163 struct request *c, uint16_t id)
165 /* XXX -- FCGI_CANT_MPX_CONN */
166 if (c->request_started) {
167 log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
171 if (n != sizeof(struct fcgi_begin_request_body)) {
172 log_warn("wrong size %d != %lu", n,
173 sizeof(struct fcgi_begin_request_body));
177 c->request_started = 1;
185 fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
187 struct env_val *env_entry;
188 uint32_t name_len, val_len;
189 uint8_t *sd, *dr_buf;
191 if (!c->request_started) {
192 log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
197 log_warn("unexpected id, ignoring");
202 gotweb_process_request(c);
207 if (buf[0] >> 7 == 0) {
213 name_len = ((buf[0] & 0x7f) << 24) +
214 (buf[1] << 16) + (buf[2] << 8) + buf[3];
222 if (buf[0] >> 7 == 0) {
228 val_len = ((buf[0] & 0x7f) << 24) +
229 (buf[1] << 16) + (buf[2] << 8) +
239 if (n < name_len + val_len)
242 if ((env_entry = malloc(sizeof(struct env_val))) == NULL) {
243 log_warn("cannot malloc env_entry");
247 if ((env_entry->val = calloc(sizeof(char), name_len + val_len +
249 log_warn("cannot allocate env_entry->val");
254 bcopy(buf, env_entry->val, name_len);
258 env_entry->val[name_len] = '\0';
259 if (val_len < MAX_QUERYSTRING && strcmp(env_entry->val,
260 "QUERY_STRING") == 0 && c->querystring[0] == '\0') {
261 bcopy(buf, c->querystring, val_len);
262 c->querystring[val_len] = '\0';
264 if (val_len < GOTWEBD_MAXTEXT && strcmp(env_entry->val,
265 "HTTP_HOST") == 0 && c->http_host[0] == '\0') {
268 * lazily get subdomain
269 * will only get domain if no subdomain exists
270 * this can still work if gotweb server name is the same
272 sd = strchr(buf, '.');
276 bcopy(buf, c->http_host, val_len);
277 c->http_host[val_len] = '\0';
279 if (val_len < MAX_DOCUMENT_ROOT && strcmp(env_entry->val,
280 "DOCUMENT_ROOT") == 0 && c->document_root[0] == '\0') {
282 /* drop first char, as it's always / */
285 bcopy(dr_buf, c->document_root, val_len - 1);
286 c->document_root[val_len] = '\0';
288 if (val_len < MAX_SERVER_NAME && strcmp(env_entry->val,
289 "SERVER_NAME") == 0 && c->server_name[0] == '\0') {
290 /* drop first char, as it's always / */
292 bcopy(buf, c->server_name, val_len);
293 c->server_name[val_len] = '\0';
295 env_entry->val[name_len] = '=';
297 bcopy(buf, (env_entry->val) + name_len + 1, val_len);
301 SLIST_INSERT_HEAD(&c->env, env_entry, entry);
302 log_debug("env[%d], %s", c->env_count, env_entry->val);
308 fcgi_timeout(int fd, short events, void *arg)
310 fcgi_cleanup_request((struct request*) arg);
314 fcgi_printf(struct request *c, const char *fmt, ...)
321 r = vasprintf(&str, fmt, ap);
325 log_warn("%s: asprintf", __func__);
329 r = fcgi_gen_binary_response(c, str, r);
335 fcgi_gen_binary_response(struct request *c, const uint8_t *data, int len)
339 if (c->sock->client_status == CLIENT_DISCONNECT)
342 if (data == NULL || len == 0)
346 * special case: send big replies -like blobs- directly
349 if (len > sizeof(c->outbuf)) {
350 if (c->outbuf_len > 0) {
351 fcgi_send_response(c, FCGI_STDOUT,
352 c->outbuf, c->outbuf_len);
355 return fcgi_send_response(c, FCGI_STDOUT, data, len);
358 if (len < sizeof(c->outbuf) - c->outbuf_len) {
359 memcpy(c->outbuf + c->outbuf_len, data, len);
360 c->outbuf_len += len;
364 r = fcgi_send_response(c, FCGI_STDOUT, c->outbuf, c->outbuf_len);
368 memcpy(c->outbuf, data, len);
374 send_response(struct request *c, int type, const uint8_t *data,
377 static const uint8_t padding[FCGI_PADDING_SIZE];
378 struct fcgi_record_header header;
382 size_t padded_len, tot;
383 int i, err = 0, th = 2000;
388 memset(&header, 0, sizeof(header));
391 header.id = htons(c->id);
392 header.content_len = htons(len);
394 /* The FastCGI spec suggests to align the output buffer */
395 tot = sizeof(header) + len;
396 padded_len = FCGI_ALIGN(tot);
397 if (padded_len > tot) {
398 header.padding_len = padded_len - tot;
399 tot += header.padding_len;
402 iov[0].iov_base = &header;
403 iov[0].iov_len = sizeof(header);
405 iov[1].iov_base = (void *)data;
406 iov[1].iov_len = len;
408 iov[2].iov_base = (void *)padding;
409 iov[2].iov_len = header.padding_len;
411 dump_fcgi_record("resp ", &header);
414 * XXX: add some simple write heuristics here
415 * On slower VMs, spotty connections, etc., we don't want to go right to
416 * disconnect. Let's at least try to write the data a few times before
420 nw = writev(c->fd, iov, nitems(iov));
422 c->sock->client_status = CLIENT_DISCONNECT;
427 if (errno == EAGAIN && err < th) {
428 nanosleep(&ts, NULL);
431 log_warn("%s: write failure", __func__);
432 c->sock->client_status = CLIENT_DISCONNECT;
437 log_debug("%s: partial write: %zu vs %zu", __func__,
441 for (i = 0; i < nitems(iov); ++i) {
442 if (nw < iov[i].iov_len) {
443 iov[i].iov_base += nw;
444 iov[i].iov_len -= nw;
447 nw -= iov[i].iov_len;
456 fcgi_send_response(struct request *c, int type, const void *data,
459 if (c->sock->client_status == CLIENT_DISCONNECT)
462 while (len > FCGI_CONTENT_SIZE) {
463 if (send_response(c, type, data, len) == -1)
466 data += FCGI_CONTENT_SIZE;
467 len -= FCGI_CONTENT_SIZE;
473 return send_response(c, type, data, len);
477 fcgi_create_end_record(struct request *c)
479 struct fcgi_end_request_body end_request;
481 memset(&end_request, 0, sizeof(end_request));
482 end_request.app_status = htonl(0); /* script status */
483 end_request.protocol_status = FCGI_REQUEST_COMPLETE;
485 fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
486 sizeof(end_request));
490 fcgi_cleanup_request(struct request *c)
495 evtimer_del(&c->tmo);
496 if (event_initialized(&c->ev))
500 gotweb_free_transport(c->t);
505 dump_fcgi_record(const char *p, struct fcgi_record_header *h)
507 dump_fcgi_record_header(p, h);
509 if (h->type == FCGI_BEGIN_REQUEST)
510 dump_fcgi_begin_request_body(p,
511 (struct fcgi_begin_request_body *)(h + 1));
512 else if (h->type == FCGI_END_REQUEST)
513 dump_fcgi_end_request_body(p,
514 (struct fcgi_end_request_body *)(h + 1));
518 dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
520 log_debug("%sversion: %d", p, h->version);
521 log_debug("%stype: %d", p, h->type);
522 log_debug("%srequestId: %d", p, ntohs(h->id));
523 log_debug("%scontentLength: %d", p, ntohs(h->content_len));
524 log_debug("%spaddingLength: %d", p, h->padding_len);
525 log_debug("%sreserved: %d", p, h->reserved);
529 dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
531 log_debug("%srole %d", p, ntohs(b->role));
532 log_debug("%sflags %d", p, b->flags);
536 dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
538 log_debug("%sappStatus: %d", p, ntohl(b->app_status));
539 log_debug("%sprotocolStatus: %d", p, b->protocol_status);