2 8a35f56c 2022-07-16 thomas * Copyright (c) 2020-2022 Tracey Emery <tracey@traceyemery.net>
3 8a35f56c 2022-07-16 thomas * Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
4 8a35f56c 2022-07-16 thomas * Copyright (c) 2013 Florian Obser <florian@openbsd.org>
6 8a35f56c 2022-07-16 thomas * Permission to use, copy, modify, and distribute this software for any
7 8a35f56c 2022-07-16 thomas * purpose with or without fee is hereby granted, provided that the above
8 8a35f56c 2022-07-16 thomas * copyright notice and this permission notice appear in all copies.
10 8a35f56c 2022-07-16 thomas * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 8a35f56c 2022-07-16 thomas * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 8a35f56c 2022-07-16 thomas * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 8a35f56c 2022-07-16 thomas * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 8a35f56c 2022-07-16 thomas * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 8a35f56c 2022-07-16 thomas * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 8a35f56c 2022-07-16 thomas * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 4fccd2fe 2023-03-08 thomas #include "got_compat.h"
21 8a35f56c 2022-07-16 thomas #include <arpa/inet.h>
22 8b925c6c 2022-07-16 thomas #include <sys/queue.h>
23 8a35f56c 2022-07-16 thomas #include <sys/socket.h>
24 8a35f56c 2022-07-16 thomas #include <sys/types.h>
25 0335d24d 2022-08-06 thomas #include <sys/uio.h>
27 8a35f56c 2022-07-16 thomas #include <errno.h>
28 8a35f56c 2022-07-16 thomas #include <event.h>
29 79393471 2022-08-27 thomas #include <imsg.h>
30 79393471 2022-08-27 thomas #include <stdarg.h>
31 8a35f56c 2022-07-16 thomas #include <stdlib.h>
32 8a35f56c 2022-07-16 thomas #include <stdio.h>
33 8a35f56c 2022-07-16 thomas #include <string.h>
34 8a35f56c 2022-07-16 thomas #include <time.h>
35 8a35f56c 2022-07-16 thomas #include <unistd.h>
37 8a35f56c 2022-07-16 thomas #include "got_error.h"
38 161663e7 2023-03-11 thomas #include "got_reference.h"
40 8a35f56c 2022-07-16 thomas #include "proc.h"
41 8a35f56c 2022-07-16 thomas #include "gotwebd.h"
42 e7e5fa49 2022-12-30 thomas #include "tmpl.h"
44 8a35f56c 2022-07-16 thomas size_t fcgi_parse_record(uint8_t *, size_t, struct request *);
45 8a35f56c 2022-07-16 thomas void fcgi_parse_begin_request(uint8_t *, uint16_t, struct request *,
46 8a35f56c 2022-07-16 thomas uint16_t);
47 8a35f56c 2022-07-16 thomas void fcgi_parse_params(uint8_t *, uint16_t, struct request *, uint16_t);
48 e5539f76 2022-08-10 thomas int fcgi_send_response(struct request *, int, const void *, size_t);
50 8a35f56c 2022-07-16 thomas void dump_fcgi_record_header(const char *, struct fcgi_record_header *);
51 8a35f56c 2022-07-16 thomas void dump_fcgi_begin_request_body(const char *,
52 8a35f56c 2022-07-16 thomas struct fcgi_begin_request_body *);
53 8a35f56c 2022-07-16 thomas void dump_fcgi_end_request_body(const char *,
54 8a35f56c 2022-07-16 thomas struct fcgi_end_request_body *);
56 8a35f56c 2022-07-16 thomas extern int cgi_inflight;
57 8a35f56c 2022-07-16 thomas extern volatile int client_cnt;
60 8a35f56c 2022-07-16 thomas fcgi_request(int fd, short events, void *arg)
62 8a35f56c 2022-07-16 thomas struct request *c = arg;
63 8a35f56c 2022-07-16 thomas ssize_t n;
64 8a35f56c 2022-07-16 thomas size_t parsed = 0;
66 8a35f56c 2022-07-16 thomas n = read(fd, c->buf + c->buf_pos + c->buf_len,
67 8a35f56c 2022-07-16 thomas FCGI_RECORD_SIZE - c->buf_pos-c->buf_len);
69 8a35f56c 2022-07-16 thomas switch (n) {
71 8a35f56c 2022-07-16 thomas switch (errno) {
72 8a35f56c 2022-07-16 thomas case EINTR:
73 8a35f56c 2022-07-16 thomas case EAGAIN:
76 8a35f56c 2022-07-16 thomas goto fail;
81 8a35f56c 2022-07-16 thomas log_debug("closed connection");
82 8a35f56c 2022-07-16 thomas goto fail;
87 8a35f56c 2022-07-16 thomas c->buf_len += n;
90 8a35f56c 2022-07-16 thomas * Parse the records as they are received. Per the FastCGI
91 8a35f56c 2022-07-16 thomas * specification, the server need only receive the FastCGI
92 8a35f56c 2022-07-16 thomas * parameter records in full; it is free to begin execution
93 8a35f56c 2022-07-16 thomas * at that point, which is what happens here.
96 8a35f56c 2022-07-16 thomas parsed = fcgi_parse_record(c->buf + c->buf_pos, c->buf_len, c);
97 8a35f56c 2022-07-16 thomas if (parsed != 0) {
98 8a35f56c 2022-07-16 thomas c->buf_pos += parsed;
99 8a35f56c 2022-07-16 thomas c->buf_len -= parsed;
102 2e9bd5cb 2023-03-10 thomas /* drop the parsed record */
103 2e9bd5cb 2023-03-10 thomas if (parsed != 0 && c->buf_len > 0) {
104 8a35f56c 2022-07-16 thomas bcopy(c->buf + c->buf_pos, c->buf, c->buf_len);
105 8a35f56c 2022-07-16 thomas c->buf_pos = 0;
107 2e9bd5cb 2023-03-10 thomas } while (parsed > 0 && c->buf_len > 0);
111 8a35f56c 2022-07-16 thomas fcgi_cleanup_request(c);
115 8a35f56c 2022-07-16 thomas fcgi_parse_record(uint8_t *buf, size_t n, struct request *c)
117 8a35f56c 2022-07-16 thomas struct fcgi_record_header *h;
119 8a35f56c 2022-07-16 thomas if (n < sizeof(struct fcgi_record_header))
120 8a35f56c 2022-07-16 thomas return 0;
122 8a35f56c 2022-07-16 thomas h = (struct fcgi_record_header*) buf;
124 8a35f56c 2022-07-16 thomas dump_fcgi_record("", h);
126 8a35f56c 2022-07-16 thomas if (n < sizeof(struct fcgi_record_header) + ntohs(h->content_len)
127 8a35f56c 2022-07-16 thomas + h->padding_len)
128 8a35f56c 2022-07-16 thomas return 0;
130 8a35f56c 2022-07-16 thomas if (h->version != 1)
131 8a35f56c 2022-07-16 thomas log_warn("wrong version");
133 8a35f56c 2022-07-16 thomas switch (h->type) {
134 8a35f56c 2022-07-16 thomas case FCGI_BEGIN_REQUEST:
135 8a35f56c 2022-07-16 thomas fcgi_parse_begin_request(buf +
136 8a35f56c 2022-07-16 thomas sizeof(struct fcgi_record_header),
137 8a35f56c 2022-07-16 thomas ntohs(h->content_len), c, ntohs(h->id));
139 8a35f56c 2022-07-16 thomas case FCGI_PARAMS:
140 8a35f56c 2022-07-16 thomas fcgi_parse_params(buf + sizeof(struct fcgi_record_header),
141 8a35f56c 2022-07-16 thomas ntohs(h->content_len), c, ntohs(h->id));
143 8a35f56c 2022-07-16 thomas case FCGI_STDIN:
144 8a35f56c 2022-07-16 thomas case FCGI_ABORT_REQUEST:
145 8a35f56c 2022-07-16 thomas fcgi_create_end_record(c);
146 8a35f56c 2022-07-16 thomas fcgi_cleanup_request(c);
147 8a35f56c 2022-07-16 thomas return 0;
149 8a35f56c 2022-07-16 thomas log_warn("unimplemented type %d", h->type);
153 8a35f56c 2022-07-16 thomas return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
154 8a35f56c 2022-07-16 thomas + h->padding_len);
158 8a35f56c 2022-07-16 thomas fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
159 8a35f56c 2022-07-16 thomas struct request *c, uint16_t id)
161 8a35f56c 2022-07-16 thomas /* XXX -- FCGI_CANT_MPX_CONN */
162 8a35f56c 2022-07-16 thomas if (c->request_started) {
163 8a35f56c 2022-07-16 thomas log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
167 8a35f56c 2022-07-16 thomas if (n != sizeof(struct fcgi_begin_request_body)) {
168 8a35f56c 2022-07-16 thomas log_warn("wrong size %d != %lu", n,
169 8a35f56c 2022-07-16 thomas sizeof(struct fcgi_begin_request_body));
173 8a35f56c 2022-07-16 thomas c->request_started = 1;
174 8a35f56c 2022-07-16 thomas c->id = id;
178 8a35f56c 2022-07-16 thomas fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
180 8a35f56c 2022-07-16 thomas uint32_t name_len, val_len;
181 b95d1cf6 2023-06-25 thomas uint8_t *val;
183 8a35f56c 2022-07-16 thomas if (!c->request_started) {
184 8a35f56c 2022-07-16 thomas log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
188 8a35f56c 2022-07-16 thomas if (c->id != id) {
189 8a35f56c 2022-07-16 thomas log_warn("unexpected id, ignoring");
193 8a35f56c 2022-07-16 thomas if (n == 0) {
194 8a35f56c 2022-07-16 thomas gotweb_process_request(c);
195 d8bf4f25 2023-09-14 thomas template_flush(c->tp);
199 8a35f56c 2022-07-16 thomas while (n > 0) {
200 8a35f56c 2022-07-16 thomas if (buf[0] >> 7 == 0) {
201 8a35f56c 2022-07-16 thomas name_len = buf[0];
205 8a35f56c 2022-07-16 thomas if (n > 3) {
206 8a35f56c 2022-07-16 thomas name_len = ((buf[0] & 0x7f) << 24) +
207 8a35f56c 2022-07-16 thomas (buf[1] << 16) + (buf[2] << 8) + buf[3];
209 8a35f56c 2022-07-16 thomas buf += 4;
214 4630b4b5 2022-09-01 thomas if (n == 0)
217 4630b4b5 2022-09-01 thomas if (buf[0] >> 7 == 0) {
218 4630b4b5 2022-09-01 thomas val_len = buf[0];
222 4630b4b5 2022-09-01 thomas if (n > 3) {
223 4630b4b5 2022-09-01 thomas val_len = ((buf[0] & 0x7f) << 24) +
224 4630b4b5 2022-09-01 thomas (buf[1] << 16) + (buf[2] << 8) +
227 4630b4b5 2022-09-01 thomas buf += 4;
232 4630b4b5 2022-09-01 thomas if (n < name_len + val_len)
235 4630b4b5 2022-09-01 thomas val = buf + name_len;
237 4630b4b5 2022-09-01 thomas if (c->querystring[0] == '\0' &&
238 4630b4b5 2022-09-01 thomas val_len < MAX_QUERYSTRING &&
239 4630b4b5 2022-09-01 thomas name_len == 12 &&
240 4630b4b5 2022-09-01 thomas strncmp(buf, "QUERY_STRING", 12) == 0) {
241 4630b4b5 2022-09-01 thomas memcpy(c->querystring, val, val_len);
242 8a35f56c 2022-07-16 thomas c->querystring[val_len] = '\0';
245 3191e256 2022-12-30 thomas if (c->document_uri[0] == '\0' &&
246 3191e256 2022-12-30 thomas val_len < MAX_DOCUMENT_URI &&
247 3191e256 2022-12-30 thomas name_len == 12 &&
248 3191e256 2022-12-30 thomas strncmp(buf, "DOCUMENT_URI", 12) == 0) {
249 3191e256 2022-12-30 thomas memcpy(c->document_uri, val, val_len);
250 3191e256 2022-12-30 thomas c->document_uri[val_len] = '\0';
253 4630b4b5 2022-09-01 thomas if (c->server_name[0] == '\0' &&
254 4630b4b5 2022-09-01 thomas val_len < MAX_SERVER_NAME &&
255 4630b4b5 2022-09-01 thomas name_len == 11 &&
256 4630b4b5 2022-09-01 thomas strncmp(buf, "SERVER_NAME", 11) == 0) {
257 4630b4b5 2022-09-01 thomas memcpy(c->server_name, val, val_len);
258 8a35f56c 2022-07-16 thomas c->server_name[val_len] = '\0';
261 d6795e9f 2022-12-30 thomas if (name_len == 5 &&
262 d6795e9f 2022-12-30 thomas strncmp(buf, "HTTPS", 5) == 0)
263 d6795e9f 2022-12-30 thomas c->https = 1;
265 4630b4b5 2022-09-01 thomas buf += name_len + val_len;
266 4630b4b5 2022-09-01 thomas n -= name_len - val_len;
271 8a35f56c 2022-07-16 thomas fcgi_timeout(int fd, short events, void *arg)
273 8a35f56c 2022-07-16 thomas fcgi_cleanup_request((struct request*) arg);
276 e5539f76 2022-08-10 thomas static int
277 0335d24d 2022-08-06 thomas send_response(struct request *c, int type, const uint8_t *data,
278 0335d24d 2022-08-06 thomas size_t len)
280 0335d24d 2022-08-06 thomas static const uint8_t padding[FCGI_PADDING_SIZE];
281 0335d24d 2022-08-06 thomas struct fcgi_record_header header;
282 0335d24d 2022-08-06 thomas struct iovec iov[3];
283 8a35f56c 2022-07-16 thomas struct timespec ts;
284 a5a99557 2022-07-29 thomas ssize_t nw;
285 0335d24d 2022-08-06 thomas size_t padded_len, tot;
286 0335d24d 2022-08-06 thomas int i, err = 0, th = 2000;
288 8a35f56c 2022-07-16 thomas ts.tv_sec = 0;
289 8a35f56c 2022-07-16 thomas ts.tv_nsec = 50;
291 0335d24d 2022-08-06 thomas memset(&header, 0, sizeof(header));
292 0335d24d 2022-08-06 thomas header.version = 1;
293 0335d24d 2022-08-06 thomas header.type = type;
294 0335d24d 2022-08-06 thomas header.id = htons(c->id);
295 0335d24d 2022-08-06 thomas header.content_len = htons(len);
297 8a35f56c 2022-07-16 thomas /* The FastCGI spec suggests to align the output buffer */
298 0335d24d 2022-08-06 thomas tot = sizeof(header) + len;
299 0335d24d 2022-08-06 thomas padded_len = FCGI_ALIGN(tot);
300 0335d24d 2022-08-06 thomas if (padded_len > tot) {
301 0335d24d 2022-08-06 thomas header.padding_len = padded_len - tot;
302 0335d24d 2022-08-06 thomas tot += header.padding_len;
305 0335d24d 2022-08-06 thomas iov[0].iov_base = &header;
306 0335d24d 2022-08-06 thomas iov[0].iov_len = sizeof(header);
308 0335d24d 2022-08-06 thomas iov[1].iov_base = (void *)data;
309 0335d24d 2022-08-06 thomas iov[1].iov_len = len;
311 0335d24d 2022-08-06 thomas iov[2].iov_base = (void *)padding;
312 0335d24d 2022-08-06 thomas iov[2].iov_len = header.padding_len;
314 0335d24d 2022-08-06 thomas dump_fcgi_record("resp ", &header);
317 8a35f56c 2022-07-16 thomas * XXX: add some simple write heuristics here
318 8a35f56c 2022-07-16 thomas * On slower VMs, spotty connections, etc., we don't want to go right to
319 8a35f56c 2022-07-16 thomas * disconnect. Let's at least try to write the data a few times before
320 8a35f56c 2022-07-16 thomas * giving up.
322 0335d24d 2022-08-06 thomas while (tot > 0) {
323 0335d24d 2022-08-06 thomas nw = writev(c->fd, iov, nitems(iov));
324 a5a99557 2022-07-29 thomas if (nw == 0) {
325 a5a99557 2022-07-29 thomas c->sock->client_status = CLIENT_DISCONNECT;
328 a5a99557 2022-07-29 thomas if (nw == -1) {
330 a5a99557 2022-07-29 thomas if (errno == EAGAIN && err < th) {
331 a5a99557 2022-07-29 thomas nanosleep(&ts, NULL);
332 a5a99557 2022-07-29 thomas continue;
334 aa2aecab 2023-05-25 thomas log_debug("%s: write failure: %s", __func__,
335 aa2aecab 2023-05-25 thomas strerror(errno));
336 8a35f56c 2022-07-16 thomas c->sock->client_status = CLIENT_DISCONNECT;
337 e5539f76 2022-08-10 thomas return -1;
340 0335d24d 2022-08-06 thomas if (nw != tot)
341 0335d24d 2022-08-06 thomas log_debug("%s: partial write: %zu vs %zu", __func__,
342 0335d24d 2022-08-06 thomas nw, tot);
344 0335d24d 2022-08-06 thomas tot -= nw;
345 0335d24d 2022-08-06 thomas for (i = 0; i < nitems(iov); ++i) {
346 0335d24d 2022-08-06 thomas if (nw < iov[i].iov_len) {
347 0335d24d 2022-08-06 thomas iov[i].iov_base += nw;
348 0335d24d 2022-08-06 thomas iov[i].iov_len -= nw;
351 0335d24d 2022-08-06 thomas nw -= iov[i].iov_len;
352 0335d24d 2022-08-06 thomas iov[i].iov_len = 0;
356 e5539f76 2022-08-10 thomas return 0;
360 0335d24d 2022-08-06 thomas fcgi_send_response(struct request *c, int type, const void *data,
361 0335d24d 2022-08-06 thomas size_t len)
363 e5539f76 2022-08-10 thomas if (c->sock->client_status == CLIENT_DISCONNECT)
364 e5539f76 2022-08-10 thomas return -1;
366 0335d24d 2022-08-06 thomas while (len > FCGI_CONTENT_SIZE) {
367 e5539f76 2022-08-10 thomas if (send_response(c, type, data, len) == -1)
368 e5539f76 2022-08-10 thomas return -1;
370 0335d24d 2022-08-06 thomas data += FCGI_CONTENT_SIZE;
371 0335d24d 2022-08-06 thomas len -= FCGI_CONTENT_SIZE;
374 0335d24d 2022-08-06 thomas if (len == 0)
375 e5539f76 2022-08-10 thomas return 0;
377 e5539f76 2022-08-10 thomas return send_response(c, type, data, len);
381 d8bf4f25 2023-09-14 thomas fcgi_write(void *arg, const void *buf, size_t len)
383 d8bf4f25 2023-09-14 thomas struct request *c = arg;
385 d8bf4f25 2023-09-14 thomas return fcgi_send_response(c, FCGI_STDOUT, buf, len);
389 8a35f56c 2022-07-16 thomas fcgi_create_end_record(struct request *c)
391 0335d24d 2022-08-06 thomas struct fcgi_end_request_body end_request;
393 0335d24d 2022-08-06 thomas memset(&end_request, 0, sizeof(end_request));
394 0335d24d 2022-08-06 thomas end_request.app_status = htonl(0); /* script status */
395 0335d24d 2022-08-06 thomas end_request.protocol_status = FCGI_REQUEST_COMPLETE;
397 0335d24d 2022-08-06 thomas fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
398 0335d24d 2022-08-06 thomas sizeof(end_request));
402 8a35f56c 2022-07-16 thomas fcgi_cleanup_request(struct request *c)
404 8a35f56c 2022-07-16 thomas cgi_inflight--;
405 8a35f56c 2022-07-16 thomas client_cnt--;
407 8a35f56c 2022-07-16 thomas evtimer_del(&c->tmo);
408 8a35f56c 2022-07-16 thomas if (event_initialized(&c->ev))
409 8a35f56c 2022-07-16 thomas event_del(&c->ev);
411 8a35f56c 2022-07-16 thomas close(c->fd);
412 e7e5fa49 2022-12-30 thomas template_free(c->tp);
413 2e9bd5cb 2023-03-10 thomas if (c->t != NULL)
414 2e9bd5cb 2023-03-10 thomas gotweb_free_transport(c->t);
419 8a35f56c 2022-07-16 thomas dump_fcgi_record(const char *p, struct fcgi_record_header *h)
421 8a35f56c 2022-07-16 thomas dump_fcgi_record_header(p, h);
423 8a35f56c 2022-07-16 thomas if (h->type == FCGI_BEGIN_REQUEST)
424 8a35f56c 2022-07-16 thomas dump_fcgi_begin_request_body(p,
425 8a35f56c 2022-07-16 thomas (struct fcgi_begin_request_body *)(h + 1));
426 8a35f56c 2022-07-16 thomas else if (h->type == FCGI_END_REQUEST)
427 8a35f56c 2022-07-16 thomas dump_fcgi_end_request_body(p,
428 8a35f56c 2022-07-16 thomas (struct fcgi_end_request_body *)(h + 1));
432 8a35f56c 2022-07-16 thomas dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
434 8a35f56c 2022-07-16 thomas log_debug("%sversion: %d", p, h->version);
435 8a35f56c 2022-07-16 thomas log_debug("%stype: %d", p, h->type);
436 8a35f56c 2022-07-16 thomas log_debug("%srequestId: %d", p, ntohs(h->id));
437 8a35f56c 2022-07-16 thomas log_debug("%scontentLength: %d", p, ntohs(h->content_len));
438 8a35f56c 2022-07-16 thomas log_debug("%spaddingLength: %d", p, h->padding_len);
439 8a35f56c 2022-07-16 thomas log_debug("%sreserved: %d", p, h->reserved);
443 8a35f56c 2022-07-16 thomas dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
445 8a35f56c 2022-07-16 thomas log_debug("%srole %d", p, ntohs(b->role));
446 8a35f56c 2022-07-16 thomas log_debug("%sflags %d", p, b->flags);
450 8a35f56c 2022-07-16 thomas dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
452 8a35f56c 2022-07-16 thomas log_debug("%sappStatus: %d", p, ntohl(b->app_status));
453 8a35f56c 2022-07-16 thomas log_debug("%sprotocolStatus: %d", p, b->protocol_status);