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 "got_compat.h"
21 #include <arpa/inet.h>
22 #include <sys/queue.h>
23 #include <sys/socket.h>
24 #include <sys/types.h>
37 #include "got_error.h"
38 #include "got_reference.h"
44 size_t fcgi_parse_record(uint8_t *, size_t, struct request *);
45 void fcgi_parse_begin_request(uint8_t *, uint16_t, struct request *,
47 void fcgi_parse_params(uint8_t *, uint16_t, struct request *, uint16_t);
48 int fcgi_send_response(struct request *, int, const void *, size_t);
50 void dump_fcgi_record_header(const char *, struct fcgi_record_header *);
51 void dump_fcgi_begin_request_body(const char *,
52 struct fcgi_begin_request_body *);
53 void dump_fcgi_end_request_body(const char *,
54 struct fcgi_end_request_body *);
56 extern int cgi_inflight;
57 extern volatile int client_cnt;
60 fcgi_request(int fd, short events, void *arg)
62 struct request *c = arg;
66 n = read(fd, c->buf + c->buf_pos + c->buf_len,
67 FCGI_RECORD_SIZE - c->buf_pos-c->buf_len);
81 log_debug("closed connection");
90 * Parse the records as they are received. Per the FastCGI
91 * specification, the server need only receive the FastCGI
92 * parameter records in full; it is free to begin execution
93 * at that point, which is what happens here.
96 parsed = fcgi_parse_record(c->buf + c->buf_pos, c->buf_len, c);
102 /* drop the parsed record */
103 if (parsed != 0 && c->buf_len > 0) {
104 bcopy(c->buf + c->buf_pos, c->buf, c->buf_len);
107 } while (parsed > 0 && c->buf_len > 0);
111 fcgi_cleanup_request(c);
115 fcgi_parse_record(uint8_t *buf, size_t n, struct request *c)
117 struct fcgi_record_header *h;
119 if (n < sizeof(struct fcgi_record_header))
122 h = (struct fcgi_record_header*) buf;
124 dump_fcgi_record("", h);
126 if (n < sizeof(struct fcgi_record_header) + ntohs(h->content_len)
131 log_warn("wrong version");
134 case FCGI_BEGIN_REQUEST:
135 fcgi_parse_begin_request(buf +
136 sizeof(struct fcgi_record_header),
137 ntohs(h->content_len), c, ntohs(h->id));
140 fcgi_parse_params(buf + sizeof(struct fcgi_record_header),
141 ntohs(h->content_len), c, ntohs(h->id));
144 case FCGI_ABORT_REQUEST:
145 fcgi_create_end_record(c);
146 fcgi_cleanup_request(c);
149 log_warn("unimplemented type %d", h->type);
153 return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
158 fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
159 struct request *c, uint16_t id)
161 /* XXX -- FCGI_CANT_MPX_CONN */
162 if (c->request_started) {
163 log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
167 if (n != sizeof(struct fcgi_begin_request_body)) {
168 log_warn("wrong size %d != %lu", n,
169 sizeof(struct fcgi_begin_request_body));
173 c->request_started = 1;
178 fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
180 uint32_t name_len, val_len;
183 if (!c->request_started) {
184 log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
189 log_warn("unexpected id, ignoring");
194 gotweb_process_request(c);
195 template_flush(c->tp);
200 if (buf[0] >> 7 == 0) {
206 name_len = ((buf[0] & 0x7f) << 24) +
207 (buf[1] << 16) + (buf[2] << 8) + buf[3];
217 if (buf[0] >> 7 == 0) {
223 val_len = ((buf[0] & 0x7f) << 24) +
224 (buf[1] << 16) + (buf[2] << 8) +
232 if (n < name_len + val_len)
235 val = buf + name_len;
237 if (c->querystring[0] == '\0' &&
238 val_len < MAX_QUERYSTRING &&
240 strncmp(buf, "QUERY_STRING", 12) == 0) {
241 memcpy(c->querystring, val, val_len);
242 c->querystring[val_len] = '\0';
245 if (c->document_uri[0] == '\0' &&
246 val_len < MAX_DOCUMENT_URI &&
248 strncmp(buf, "DOCUMENT_URI", 12) == 0) {
249 memcpy(c->document_uri, val, val_len);
250 c->document_uri[val_len] = '\0';
253 if (c->server_name[0] == '\0' &&
254 val_len < MAX_SERVER_NAME &&
256 strncmp(buf, "SERVER_NAME", 11) == 0) {
257 memcpy(c->server_name, val, val_len);
258 c->server_name[val_len] = '\0';
262 strncmp(buf, "HTTPS", 5) == 0)
265 buf += name_len + val_len;
266 n -= name_len - val_len;
271 fcgi_timeout(int fd, short events, void *arg)
273 fcgi_cleanup_request((struct request*) arg);
277 send_response(struct request *c, int type, const uint8_t *data,
280 static const uint8_t padding[FCGI_PADDING_SIZE];
281 struct fcgi_record_header header;
285 size_t padded_len, tot;
286 int i, err = 0, th = 2000;
291 memset(&header, 0, sizeof(header));
294 header.id = htons(c->id);
295 header.content_len = htons(len);
297 /* The FastCGI spec suggests to align the output buffer */
298 tot = sizeof(header) + len;
299 padded_len = FCGI_ALIGN(tot);
300 if (padded_len > tot) {
301 header.padding_len = padded_len - tot;
302 tot += header.padding_len;
305 iov[0].iov_base = &header;
306 iov[0].iov_len = sizeof(header);
308 iov[1].iov_base = (void *)data;
309 iov[1].iov_len = len;
311 iov[2].iov_base = (void *)padding;
312 iov[2].iov_len = header.padding_len;
314 dump_fcgi_record("resp ", &header);
317 * XXX: add some simple write heuristics here
318 * On slower VMs, spotty connections, etc., we don't want to go right to
319 * disconnect. Let's at least try to write the data a few times before
323 nw = writev(c->fd, iov, nitems(iov));
325 c->sock->client_status = CLIENT_DISCONNECT;
330 if (errno == EAGAIN && err < th) {
331 nanosleep(&ts, NULL);
334 log_debug("%s: write failure: %s", __func__,
336 c->sock->client_status = CLIENT_DISCONNECT;
341 log_debug("%s: partial write: %zu vs %zu", __func__,
345 for (i = 0; i < nitems(iov); ++i) {
346 if (nw < iov[i].iov_len) {
347 iov[i].iov_base += nw;
348 iov[i].iov_len -= nw;
351 nw -= iov[i].iov_len;
360 fcgi_send_response(struct request *c, int type, const void *data,
363 if (c->sock->client_status == CLIENT_DISCONNECT)
366 while (len > FCGI_CONTENT_SIZE) {
367 if (send_response(c, type, data, len) == -1)
370 data += FCGI_CONTENT_SIZE;
371 len -= FCGI_CONTENT_SIZE;
377 return send_response(c, type, data, len);
381 fcgi_write(void *arg, const void *buf, size_t len)
383 struct request *c = arg;
385 return fcgi_send_response(c, FCGI_STDOUT, buf, len);
389 fcgi_create_end_record(struct request *c)
391 struct fcgi_end_request_body end_request;
393 memset(&end_request, 0, sizeof(end_request));
394 end_request.app_status = htonl(0); /* script status */
395 end_request.protocol_status = FCGI_REQUEST_COMPLETE;
397 fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
398 sizeof(end_request));
402 fcgi_cleanup_request(struct request *c)
407 evtimer_del(&c->tmo);
408 if (event_initialized(&c->ev))
412 template_free(c->tp);
414 gotweb_free_transport(c->t);
419 dump_fcgi_record(const char *p, struct fcgi_record_header *h)
421 dump_fcgi_record_header(p, h);
423 if (h->type == FCGI_BEGIN_REQUEST)
424 dump_fcgi_begin_request_body(p,
425 (struct fcgi_begin_request_body *)(h + 1));
426 else if (h->type == FCGI_END_REQUEST)
427 dump_fcgi_end_request_body(p,
428 (struct fcgi_end_request_body *)(h + 1));
432 dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
434 log_debug("%sversion: %d", p, h->version);
435 log_debug("%stype: %d", p, h->type);
436 log_debug("%srequestId: %d", p, ntohs(h->id));
437 log_debug("%scontentLength: %d", p, ntohs(h->content_len));
438 log_debug("%spaddingLength: %d", p, h->padding_len);
439 log_debug("%sreserved: %d", p, h->reserved);
443 dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
445 log_debug("%srole %d", p, ntohs(b->role));
446 log_debug("%sflags %d", p, b->flags);
450 dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
452 log_debug("%sappStatus: %d", p, ntohl(b->app_status));
453 log_debug("%sprotocolStatus: %d", p, b->protocol_status);