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"
36 #include "got_reference.h"
41 size_t fcgi_parse_record(uint8_t *, size_t, struct request *);
42 void fcgi_parse_begin_request(uint8_t *, uint16_t, struct request *,
44 void fcgi_parse_params(uint8_t *, uint16_t, struct request *, uint16_t);
45 int fcgi_send_response(struct request *, int, const void *, size_t);
47 void dump_fcgi_record_header(const char *, struct fcgi_record_header *);
48 void dump_fcgi_begin_request_body(const char *,
49 struct fcgi_begin_request_body *);
50 void dump_fcgi_end_request_body(const char *,
51 struct fcgi_end_request_body *);
53 extern int cgi_inflight;
54 extern volatile int client_cnt;
57 fcgi_request(int fd, short events, void *arg)
59 struct request *c = arg;
63 n = read(fd, c->buf + c->buf_pos + c->buf_len,
64 FCGI_RECORD_SIZE - c->buf_pos-c->buf_len);
78 log_debug("closed connection");
87 * Parse the records as they are received. Per the FastCGI
88 * specification, the server need only receive the FastCGI
89 * parameter records in full; it is free to begin execution
90 * at that point, which is what happens here.
93 parsed = fcgi_parse_record(c->buf + c->buf_pos, c->buf_len, c);
99 /* drop the parsed record */
100 if (parsed != 0 && c->buf_len > 0) {
101 bcopy(c->buf + c->buf_pos, c->buf, c->buf_len);
104 } while (parsed > 0 && c->buf_len > 0);
108 fcgi_cleanup_request(c);
112 fcgi_parse_record(uint8_t *buf, size_t n, struct request *c)
114 struct fcgi_record_header *h;
116 if (n < sizeof(struct fcgi_record_header))
119 h = (struct fcgi_record_header*) buf;
121 dump_fcgi_record("", h);
123 if (n < sizeof(struct fcgi_record_header) + ntohs(h->content_len)
128 log_warn("wrong version");
131 case FCGI_BEGIN_REQUEST:
132 fcgi_parse_begin_request(buf +
133 sizeof(struct fcgi_record_header),
134 ntohs(h->content_len), c, ntohs(h->id));
137 fcgi_parse_params(buf + sizeof(struct fcgi_record_header),
138 ntohs(h->content_len), c, ntohs(h->id));
141 case FCGI_ABORT_REQUEST:
142 fcgi_create_end_record(c);
143 fcgi_cleanup_request(c);
146 log_warn("unimplemented type %d", h->type);
150 return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
155 fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
156 struct request *c, uint16_t id)
158 /* XXX -- FCGI_CANT_MPX_CONN */
159 if (c->request_started) {
160 log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
164 if (n != sizeof(struct fcgi_begin_request_body)) {
165 log_warn("wrong size %d != %lu", n,
166 sizeof(struct fcgi_begin_request_body));
170 c->request_started = 1;
175 fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
177 uint32_t name_len, val_len;
180 if (!c->request_started) {
181 log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
186 log_warn("unexpected id, ignoring");
191 gotweb_process_request(c);
192 template_flush(c->tp);
197 if (buf[0] >> 7 == 0) {
203 name_len = ((buf[0] & 0x7f) << 24) +
204 (buf[1] << 16) + (buf[2] << 8) + buf[3];
214 if (buf[0] >> 7 == 0) {
220 val_len = ((buf[0] & 0x7f) << 24) +
221 (buf[1] << 16) + (buf[2] << 8) +
229 if (n < name_len + val_len)
232 val = buf + name_len;
234 if (c->querystring[0] == '\0' &&
235 val_len < MAX_QUERYSTRING &&
237 strncmp(buf, "QUERY_STRING", 12) == 0) {
238 memcpy(c->querystring, val, val_len);
239 c->querystring[val_len] = '\0';
242 if (c->document_uri[0] == '\0' &&
243 val_len < MAX_DOCUMENT_URI &&
245 strncmp(buf, "DOCUMENT_URI", 12) == 0) {
246 memcpy(c->document_uri, val, val_len);
247 c->document_uri[val_len] = '\0';
250 if (c->server_name[0] == '\0' &&
251 val_len < MAX_SERVER_NAME &&
253 strncmp(buf, "SERVER_NAME", 11) == 0) {
254 memcpy(c->server_name, val, val_len);
255 c->server_name[val_len] = '\0';
259 strncmp(buf, "HTTPS", 5) == 0)
262 buf += name_len + val_len;
263 n -= name_len - val_len;
268 fcgi_timeout(int fd, short events, void *arg)
270 fcgi_cleanup_request((struct request*) arg);
274 send_response(struct request *c, int type, const uint8_t *data,
277 static const uint8_t padding[FCGI_PADDING_SIZE];
278 struct fcgi_record_header header;
282 size_t padded_len, tot;
283 int i, err = 0, th = 2000;
288 memset(&header, 0, sizeof(header));
291 header.id = htons(c->id);
292 header.content_len = htons(len);
294 /* The FastCGI spec suggests to align the output buffer */
295 tot = sizeof(header) + len;
296 padded_len = FCGI_ALIGN(tot);
297 if (padded_len > tot) {
298 header.padding_len = padded_len - tot;
299 tot += header.padding_len;
302 iov[0].iov_base = &header;
303 iov[0].iov_len = sizeof(header);
305 iov[1].iov_base = (void *)data;
306 iov[1].iov_len = len;
308 iov[2].iov_base = (void *)padding;
309 iov[2].iov_len = header.padding_len;
311 dump_fcgi_record("resp ", &header);
314 * XXX: add some simple write heuristics here
315 * On slower VMs, spotty connections, etc., we don't want to go right to
316 * disconnect. Let's at least try to write the data a few times before
320 nw = writev(c->fd, iov, nitems(iov));
322 c->sock->client_status = CLIENT_DISCONNECT;
327 if (errno == EAGAIN && err < th) {
328 nanosleep(&ts, NULL);
331 log_debug("%s: write failure: %s", __func__,
333 c->sock->client_status = CLIENT_DISCONNECT;
338 log_debug("%s: partial write: %zu vs %zu", __func__,
342 for (i = 0; i < nitems(iov); ++i) {
343 if (nw < iov[i].iov_len) {
344 iov[i].iov_base += nw;
345 iov[i].iov_len -= nw;
348 nw -= iov[i].iov_len;
357 fcgi_send_response(struct request *c, int type, const void *data,
360 if (c->sock->client_status == CLIENT_DISCONNECT)
363 while (len > FCGI_CONTENT_SIZE) {
364 if (send_response(c, type, data, len) == -1)
367 data += FCGI_CONTENT_SIZE;
368 len -= FCGI_CONTENT_SIZE;
374 return send_response(c, type, data, len);
378 fcgi_write(void *arg, const void *buf, size_t len)
380 struct request *c = arg;
382 return fcgi_send_response(c, FCGI_STDOUT, buf, len);
386 fcgi_create_end_record(struct request *c)
388 struct fcgi_end_request_body end_request;
390 memset(&end_request, 0, sizeof(end_request));
391 end_request.app_status = htonl(0); /* script status */
392 end_request.protocol_status = FCGI_REQUEST_COMPLETE;
394 fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
395 sizeof(end_request));
399 fcgi_cleanup_request(struct request *c)
404 evtimer_del(&c->tmo);
405 if (event_initialized(&c->ev))
409 template_free(c->tp);
411 gotweb_free_transport(c->t);
416 dump_fcgi_record(const char *p, struct fcgi_record_header *h)
418 dump_fcgi_record_header(p, h);
420 if (h->type == FCGI_BEGIN_REQUEST)
421 dump_fcgi_begin_request_body(p,
422 (struct fcgi_begin_request_body *)(h + 1));
423 else if (h->type == FCGI_END_REQUEST)
424 dump_fcgi_end_request_body(p,
425 (struct fcgi_end_request_body *)(h + 1));
429 dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
431 log_debug("%sversion: %d", p, h->version);
432 log_debug("%stype: %d", p, h->type);
433 log_debug("%srequestId: %d", p, ntohs(h->id));
434 log_debug("%scontentLength: %d", p, ntohs(h->content_len));
435 log_debug("%spaddingLength: %d", p, h->padding_len);
436 log_debug("%sreserved: %d", p, h->reserved);
440 dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
442 log_debug("%srole %d", p, ntohs(b->role));
443 log_debug("%sflags %d", p, b->flags);
447 dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
449 log_debug("%sappStatus: %d", p, ntohl(b->app_status));
450 log_debug("%sprotocolStatus: %d", p, b->protocol_status);