1 /*
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>
5  *
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.
9  *
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.
17  */
18 
19 #include <arpa/inet.h>
20 #include <sys/queue.h>
21 #include <sys/socket.h>
22 #include <sys/types.h>
23 #include <sys/uio.h>
24 
25 #include <errno.h>
26 #include <event.h>
27 #include <imsg.h>
28 #include <stdarg.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <time.h>
33 #include <unistd.h>
34 
35 #include "got_error.h"
36 
37 #include "proc.h"
38 #include "gotwebd.h"
39 
40 size_t	 fcgi_parse_record(uint8_t *, size_t, struct request *);
41 void	 fcgi_parse_begin_request(uint8_t *, uint16_t, struct request *,
42 	    uint16_t);
43 void	 fcgi_parse_params(uint8_t *, uint16_t, struct request *, uint16_t);
44 int	 fcgi_send_response(struct request *, int, const void *, size_t);
45 
46 void	 dump_fcgi_record_header(const char *, struct fcgi_record_header *);
47 void	 dump_fcgi_begin_request_body(const char *,
48 	    struct fcgi_begin_request_body *);
49 void	 dump_fcgi_end_request_body(const char *,
50 	    struct fcgi_end_request_body *);
51 
52 extern int	 cgi_inflight;
53 extern volatile int client_cnt;
54 
55 void
56 fcgi_request(int fd, short events, void *arg)
57 {
58 	struct request *c = arg;
59 	ssize_t n;
60 	size_t parsed = 0;
61 
62 	n = read(fd, c->buf + c->buf_pos + c->buf_len,
63 	    FCGI_RECORD_SIZE - c->buf_pos-c->buf_len);
64 
65 	switch (n) {
66 	case -1:
67 		switch (errno) {
68 		case EINTR:
69 		case EAGAIN:
70 			return;
71 		default:
72 			goto fail;
73 		}
74 		break;
75 
76 	case 0:
77 		log_debug("closed connection");
78 		goto fail;
79 	default:
80 		break;
81 	}
82 
83 	c->buf_len += n;
84 
85 	/*
86 	 * Parse the records as they are received. Per the FastCGI
87 	 * specification, the server need only receive the FastCGI
88 	 * parameter records in full; it is free to begin execution
89 	 * at that point, which is what happens here.
90 	 */
91 	do {
92 		parsed = fcgi_parse_record(c->buf + c->buf_pos, c->buf_len, c);
93 		if (parsed != 0) {
94 			c->buf_pos += parsed;
95 			c->buf_len -= parsed;
96 		}
97 	} while (parsed > 0 && c->buf_len > 0);
98 
99 	/* Make space for further reads */
100 	if (parsed != 0)
101 		if (c->buf_len > 0) {
102 			bcopy(c->buf + c->buf_pos, c->buf, c->buf_len);
103 			c->buf_pos = 0;
104 		}
105 	return;
106 fail:
107 	fcgi_cleanup_request(c);
108 }
109 
110 size_t
111 fcgi_parse_record(uint8_t *buf, size_t n, struct request *c)
112 {
113 	struct fcgi_record_header *h;
114 
115 	if (n < sizeof(struct fcgi_record_header))
116 		 return 0;
117 
118 	h = (struct fcgi_record_header*) buf;
119 
120 	dump_fcgi_record("", h);
121 
122 	if (n < sizeof(struct fcgi_record_header) + ntohs(h->content_len)
123 	    + h->padding_len)
124 		 return 0;
125 
126 	if (h->version != 1)
127 		log_warn("wrong version");
128 
129 	switch (h->type) {
130 	case FCGI_BEGIN_REQUEST:
131 		fcgi_parse_begin_request(buf +
132 		    sizeof(struct fcgi_record_header),
133 		    ntohs(h->content_len), c, ntohs(h->id));
134 		break;
135 	case FCGI_PARAMS:
136 		fcgi_parse_params(buf + sizeof(struct fcgi_record_header),
137 		    ntohs(h->content_len), c, ntohs(h->id));
138 		break;
139 	case FCGI_STDIN:
140 	case FCGI_ABORT_REQUEST:
141 		if (c->sock->client_status != CLIENT_DISCONNECT &&
142 		    c->outbuf_len != 0) {
143 			fcgi_send_response(c, FCGI_STDOUT, c->outbuf,
144 			    c->outbuf_len);
145 		}
146 
147 		fcgi_create_end_record(c);
148 		fcgi_cleanup_request(c);
149 		return 0;
150 	default:
151 		log_warn("unimplemented type %d", h->type);
152 		break;
153 	}
154 
155 	return (sizeof(struct fcgi_record_header) + ntohs(h->content_len)
156 	    + h->padding_len);
157 }
158 
159 void
160 fcgi_parse_begin_request(uint8_t *buf, uint16_t n,
161     struct request *c, uint16_t id)
162 {
163 	/* XXX -- FCGI_CANT_MPX_CONN */
164 	if (c->request_started) {
165 		log_warn("unexpected FCGI_BEGIN_REQUEST, ignoring");
166 		return;
167 	}
168 
169 	if (n != sizeof(struct fcgi_begin_request_body)) {
170 		log_warn("wrong size %d != %lu", n,
171 		    sizeof(struct fcgi_begin_request_body));
172 		return;
173 	}
174 
175 	c->request_started = 1;
176 	c->id = id;
177 }
178 
179 void
180 fcgi_parse_params(uint8_t *buf, uint16_t n, struct request *c, uint16_t id)
181 {
182 	uint32_t name_len, val_len;
183 	uint8_t *sd, *val;
184 
185 	if (!c->request_started) {
186 		log_warn("FCGI_PARAMS without FCGI_BEGIN_REQUEST, ignoring");
187 		return;
188 	}
189 
190 	if (c->id != id) {
191 		log_warn("unexpected id, ignoring");
192 		return;
193 	}
194 
195 	if (n == 0) {
196 		gotweb_process_request(c);
197 		return;
198 	}
199 
200 	while (n > 0) {
201 		if (buf[0] >> 7 == 0) {
202 			name_len = buf[0];
203 			n--;
204 			buf++;
205 		} else {
206 			if (n > 3) {
207 				name_len = ((buf[0] & 0x7f) << 24) +
208 				    (buf[1] << 16) + (buf[2] << 8) + buf[3];
209 				n -= 4;
210 				buf += 4;
211 			} else
212 				return;
213 		}
214 
215 		if (n == 0)
216 			return;
217 
218 		if (buf[0] >> 7 == 0) {
219 			val_len = buf[0];
220 			n--;
221 			buf++;
222 		} else {
223 			if (n > 3) {
224 				val_len = ((buf[0] & 0x7f) << 24) +
225 					(buf[1] << 16) + (buf[2] << 8) +
226 					buf[3];
227 				n -= 4;
228 				buf += 4;
229 			} else
230 				return;
231 		}
232 
233 		if (n < name_len + val_len)
234 			return;
235 
236 		val = buf + name_len;
237 
238 		if (c->querystring[0] == '\0' &&
239 		    val_len < MAX_QUERYSTRING &&
240 		    name_len == 12 &&
241 		    strncmp(buf, "QUERY_STRING", 12) == 0) {
242 			memcpy(c->querystring, val, val_len);
243 			c->querystring[val_len] = '\0';
244 		}
245 
246 		if (c->http_host[0] == '\0' &&
247 		    val_len < GOTWEBD_MAXTEXT &&
248 		    name_len == 9 &&
249 		    strncmp(buf, "HTTP_HOST", 9) == 0) {
250 			memcpy(c->http_host, val, val_len);
251 			c->http_host[val_len] = '\0';
252 
253 			/*
254 			 * lazily get subdomain
255 			 * will only get domain if no subdomain exists
256 			 * this can still work if gotweb server name is the same
257 			 */
258 			sd = strchr(c->http_host, '.');
259 			if (sd)
260 				*sd = '\0';
261 		}
262 
263 		if (c->script_name[0] == '\0' &&
264 		    val_len < MAX_SCRIPT_NAME &&
265 		    name_len == 11 &&
266 		    strncmp(buf, "SCRIPT_NAME", 11) == 0) {
267 			memcpy(c->script_name, val, val_len);
268 			c->script_name[val_len] = '\0';
269 		}
270 
271 		if (c->server_name[0] == '\0' &&
272 		    val_len < MAX_SERVER_NAME &&
273 		    name_len == 11 &&
274 		    strncmp(buf, "SERVER_NAME", 11) == 0) {
275 			memcpy(c->server_name, val, val_len);
276 			c->server_name[val_len] = '\0';
277 		}
278 
279 		buf += name_len + val_len;
280 		n -= name_len - val_len;
281 	}
282 }
283 
284 void
285 fcgi_timeout(int fd, short events, void *arg)
286 {
287 	fcgi_cleanup_request((struct request*) arg);
288 }
289 
290 int
291 fcgi_printf(struct request *c, const char *fmt, ...)
292 {
293 	va_list ap;
294 	char *str;
295 	int r;
296 
297 	va_start(ap, fmt);
298 	r = vasprintf(&str, fmt, ap);
299 	va_end(ap);
300 
301 	if (r == -1) {
302 		log_warn("%s: asprintf", __func__);
303 		return -1;
304 	}
305 
306 	r = fcgi_gen_binary_response(c, str, r);
307 	free(str);
308 	return r;
309 }
310 
311 int
312 fcgi_gen_binary_response(struct request *c, const uint8_t *data, int len)
313 {
314 	int r;
315 
316 	if (c->sock->client_status == CLIENT_DISCONNECT)
317 		return -1;
318 
319 	if (data == NULL || len == 0)
320 		return 0;
321 
322 	/*
323 	 * special case: send big replies -like blobs- directly
324 	 * without copying.
325 	 */
326 	if (len > sizeof(c->outbuf)) {
327 		if (c->outbuf_len > 0) {
328 			fcgi_send_response(c, FCGI_STDOUT,
329 			    c->outbuf, c->outbuf_len);
330 			c->outbuf_len = 0;
331 		}
332 		return fcgi_send_response(c, FCGI_STDOUT, data, len);
333 	}
334 
335 	if (len < sizeof(c->outbuf) - c->outbuf_len) {
336 		memcpy(c->outbuf + c->outbuf_len, data, len);
337 		c->outbuf_len += len;
338 		return 0;
339 	}
340 
341 	r = fcgi_send_response(c, FCGI_STDOUT, c->outbuf, c->outbuf_len);
342 	if (r == -1)
343 		return -1;
344 
345 	memcpy(c->outbuf, data, len);
346 	c->outbuf_len = len;
347 	return 0;
348 }
349 
350 static int
351 send_response(struct request *c, int type, const uint8_t *data,
352     size_t len)
353 {
354 	static const uint8_t padding[FCGI_PADDING_SIZE];
355 	struct fcgi_record_header header;
356 	struct iovec iov[3];
357 	struct timespec ts;
358 	ssize_t nw;
359 	size_t padded_len, tot;
360 	int i, err = 0, th = 2000;
361 
362 	ts.tv_sec = 0;
363 	ts.tv_nsec = 50;
364 
365 	memset(&header, 0, sizeof(header));
366 	header.version = 1;
367 	header.type = type;
368 	header.id = htons(c->id);
369 	header.content_len = htons(len);
370 
371 	/* The FastCGI spec suggests to align the output buffer */
372 	tot = sizeof(header) + len;
373 	padded_len = FCGI_ALIGN(tot);
374 	if (padded_len > tot) {
375 		header.padding_len = padded_len - tot;
376 		tot += header.padding_len;
377 	}
378 
379 	iov[0].iov_base = &header;
380 	iov[0].iov_len = sizeof(header);
381 
382 	iov[1].iov_base = (void *)data;
383 	iov[1].iov_len = len;
384 
385 	iov[2].iov_base = (void *)padding;
386 	iov[2].iov_len = header.padding_len;
387 
388 	dump_fcgi_record("resp ", &header);
389 
390 	/*
391 	 * XXX: add some simple write heuristics here
392 	 * On slower VMs, spotty connections, etc., we don't want to go right to
393 	 * disconnect. Let's at least try to write the data a few times before
394 	 * giving up.
395 	 */
396 	while (tot > 0) {
397 		nw = writev(c->fd, iov, nitems(iov));
398 		if (nw == 0) {
399 			c->sock->client_status = CLIENT_DISCONNECT;
400 			break;
401 		}
402 		if (nw == -1) {
403 			err++;
404 			if (errno == EAGAIN && err < th) {
405 				nanosleep(&ts, NULL);
406 				continue;
407 			}
408 			log_warn("%s: write failure", __func__);
409 			c->sock->client_status = CLIENT_DISCONNECT;
410 			return -1;
411 		}
412 
413 		if (nw != tot)
414 			log_debug("%s: partial write: %zu vs %zu", __func__,
415 			    nw, tot);
416 
417 		tot -= nw;
418 		for (i = 0; i < nitems(iov); ++i) {
419 			if (nw < iov[i].iov_len) {
420 				iov[i].iov_base += nw;
421 				iov[i].iov_len -= nw;
422 				break;
423 			}
424 			nw -= iov[i].iov_len;
425 			iov[i].iov_len = 0;
426 		}
427 	}
428 
429 	return 0;
430 }
431 
432 int
433 fcgi_send_response(struct request *c, int type, const void *data,
434     size_t len)
435 {
436 	if (c->sock->client_status == CLIENT_DISCONNECT)
437 		return -1;
438 
439 	while (len > FCGI_CONTENT_SIZE) {
440 		if (send_response(c, type, data, len) == -1)
441 			return -1;
442 
443 		data += FCGI_CONTENT_SIZE;
444 		len -= FCGI_CONTENT_SIZE;
445 	}
446 
447 	if (len == 0)
448 		return 0;
449 
450 	return send_response(c, type, data, len);
451 }
452 
453 void
454 fcgi_create_end_record(struct request *c)
455 {
456 	struct fcgi_end_request_body end_request;
457 
458 	memset(&end_request, 0, sizeof(end_request));
459 	end_request.app_status = htonl(0); /* script status */
460 	end_request.protocol_status = FCGI_REQUEST_COMPLETE;
461 
462 	fcgi_send_response(c, FCGI_END_REQUEST, &end_request,
463 	    sizeof(end_request));
464 }
465 
466 void
467 fcgi_cleanup_request(struct request *c)
468 {
469 	cgi_inflight--;
470 	client_cnt--;
471 
472 	evtimer_del(&c->tmo);
473 	if (event_initialized(&c->ev))
474 		event_del(&c->ev);
475 
476 	close(c->fd);
477 	gotweb_free_transport(c->t);
478 	free(c);
479 }
480 
481 void
482 dump_fcgi_record(const char *p, struct fcgi_record_header *h)
483 {
484 	dump_fcgi_record_header(p, h);
485 
486 	if (h->type == FCGI_BEGIN_REQUEST)
487 		dump_fcgi_begin_request_body(p,
488 		    (struct fcgi_begin_request_body *)(h + 1));
489 	else if (h->type == FCGI_END_REQUEST)
490 		dump_fcgi_end_request_body(p,
491 		    (struct fcgi_end_request_body *)(h + 1));
492 }
493 
494 void
495 dump_fcgi_record_header(const char* p, struct fcgi_record_header *h)
496 {
497 	log_debug("%sversion:         %d", p, h->version);
498 	log_debug("%stype:            %d", p, h->type);
499 	log_debug("%srequestId:       %d", p, ntohs(h->id));
500 	log_debug("%scontentLength:   %d", p, ntohs(h->content_len));
501 	log_debug("%spaddingLength:   %d", p, h->padding_len);
502 	log_debug("%sreserved:        %d", p, h->reserved);
503 }
504 
505 void
506 dump_fcgi_begin_request_body(const char *p, struct fcgi_begin_request_body *b)
507 {
508 	log_debug("%srole             %d", p, ntohs(b->role));
509 	log_debug("%sflags            %d", p, b->flags);
510 }
511 
512 void
513 dump_fcgi_end_request_body(const char *p, struct fcgi_end_request_body *b)
514 {
515 	log_debug("%sappStatus:       %d", p, ntohl(b->app_status));
516 	log_debug("%sprotocolStatus:  %d", p, b->protocol_status);
517 }