Got Mirror

Blob

Date:: Tue Aug 30 08:59:52 2022 UTC
Message:: allow multiple "listen on" statements per server in gotwebd.conf ok tracey
Actions:: History | Blame | Raw File
1 /*
2  * Copyright (c) 2016, 2019, 2020-2021 Tracey Emery <tracey@traceyemery.net>
3  * Copyright (c) 2015 Mike Larkin <mlarkin@openbsd.org>
4  * Copyright (c) 2013 David Gwynne <dlg@openbsd.org>
5  * Copyright (c) 2013 Florian Obser <florian@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #include <sys/param.h>
21 #include <sys/ioctl.h>
22 #include <sys/queue.h>
23 #include <sys/wait.h>
24 #include <sys/uio.h>
25 #include <sys/resource.h>
26 #include <sys/socket.h>
27 #include <sys/stat.h>
28 #include <sys/time.h>
29 #include <sys/types.h>
30 #include <sys/mman.h>
31 #include <sys/un.h>
32 
33 #include <net/if.h>
34 #include <netinet/in.h>
35 
36 #include <errno.h>
37 #include <event.h>
38 #include <fcntl.h>
39 #include <ifaddrs.h>
40 #include <limits.h>
41 #include <netdb.h>
42 #include <poll.h>
43 #include <pwd.h>
44 #include <stddef.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <unistd.h>
49 
50 #include "got_error.h"
51 #include "got_opentemp.h"
52 
53 #include "proc.h"
54 #include "gotwebd.h"
55 
56 #include "got_compat.h"
57 
58 #define SOCKS_BACKLOG 5
59 #define MAXIMUM(a, b)	(((a) > (b)) ? (a) : (b))
60 
61 
62 volatile int client_cnt;
63 
64 static struct timeval	timeout = { TIMEOUT_DEFAULT, 0 };
65 
66 static void	 sockets_sighdlr(int, short, void *);
67 static void	 sockets_run(struct privsep *, struct privsep_proc *, void *);
68 static void	 sockets_launch(void);
69 static void	 sockets_purge(struct gotwebd *);
70 static void	 sockets_accept_paused(int, short, void *);
71 static void	 sockets_rlimit(int);
72 
73 static int	 sockets_dispatch_gotwebd(int, struct privsep_proc *,
74 		    struct imsg *);
75 static int	 sockets_unix_socket_listen(struct privsep *, struct socket *);
76 static int	 sockets_create_socket(struct address *, in_port_t);
77 static int	 sockets_accept_reserve(int, struct sockaddr *, socklen_t *,
78 		    int, volatile int *);
79 
80 static struct socket *sockets_conf_new_socket_unix(struct gotwebd *,
81 		    struct server *, int);
82 static struct socket *sockets_conf_new_socket_fcgi(struct gotwebd *,
83 		    struct server *, int, struct address *);
84 
85 int cgi_inflight = 0;
86 
87 static struct privsep_proc procs[] = {
88 	{ "gotwebd",	PROC_GOTWEBD,	sockets_dispatch_gotwebd  },
89 };
90 
91 void
92 sockets(struct privsep *ps, struct privsep_proc *p)
93 {
94 	proc_run(ps, p, procs, nitems(procs), sockets_run, NULL);
95 }
96 
97 static void
98 sockets_run(struct privsep *ps, struct privsep_proc *p, void *arg)
99 {
100 	if (config_init(ps->ps_env) == -1)
101 		fatal("failed to initialize configuration");
102 
103 	p->p_shutdown = sockets_shutdown;
104 
105 	sockets_rlimit(-1);
106 
107 	signal_del(&ps->ps_evsigchld);
108 	signal_set(&ps->ps_evsigchld, SIGCHLD, sockets_sighdlr, ps);
109 	signal_add(&ps->ps_evsigchld, NULL);
110 
111 #ifndef PROFILE
112 	if (pledge("stdio rpath wpath cpath inet recvfd proc exec sendfd",
113 	    NULL) == -1)
114 		fatal("pledge");
115 #endif
116 }
117 
118 void
119 sockets_parse_sockets(struct gotwebd *env)
120 {
121 	struct server *srv;
122 	struct address *a;
123 	struct socket *new_sock = NULL;
124 	int sock_id = 1;
125 
126 	TAILQ_FOREACH(srv, &env->servers, entry) {
127 		if (srv->unix_socket) {
128 			new_sock = sockets_conf_new_socket_unix(env, srv,
129 			    sock_id);
130 			if (new_sock) {
131 				sock_id++;
132 				TAILQ_INSERT_TAIL(&env->sockets, new_sock,
133 				    entry);
134 			}
135 		}
136 
137 		if (srv->fcgi_socket) {
138 			if (TAILQ_EMPTY(&srv->al)) {
139 				fatalx("%s: server %s has no IP addresses to "
140 				    "listen for FCGI connections", __func__,
141 				    srv->name);
142 			}
143 			TAILQ_FOREACH(a, &srv->al, entry) {
144 				if (a->ss.ss_family != AF_INET &&
145 				    a->ss.ss_family != AF_INET6)
146 					continue;
147 				new_sock = sockets_conf_new_socket_fcgi(env,
148 				    srv, sock_id, a);
149 				if (new_sock) {
150 					sock_id++;
151 					TAILQ_INSERT_TAIL(&env->sockets,
152 					    new_sock, entry);
153 				}
154 			}
155 		}
156 	}
157 }
158 
159 static struct socket *
160 sockets_conf_new_socket_unix(struct gotwebd *env, struct server *srv, int id)
161 {
162 	struct socket *sock;
163 	int n;
164 
165 	if ((sock = calloc(1, sizeof(*sock))) == NULL)
166 		fatalx("%s: calloc", __func__);
167 
168 	sock->conf.id = id;
169 	sock->fd = -1;
170 	sock->conf.af_type = AF_UNIX;
171 
172 	if (strlcpy(sock->conf.unix_socket_name,
173 	    srv->unix_socket_name,
174 	    sizeof(sock->conf.unix_socket_name)) >=
175 	    sizeof(sock->conf.unix_socket_name)) {
176 		free(sock);
177 		fatalx("%s: strlcpy", __func__);
178 	}
179 
180 	n = snprintf(sock->conf.name, GOTWEBD_MAXTEXT, "%s_parent",
181 	    srv->name);
182 	if (n < 0 || (size_t)n >= GOTWEBD_MAXTEXT) {
183 		free(sock);
184 		fatalx("%s: snprintf", __func__);
185 	}
186 
187 	if (strlcpy(sock->conf.srv_name, srv->name,
188 	    sizeof(sock->conf.srv_name)) >= sizeof(sock->conf.srv_name)) {
189 		free(sock);
190 		fatalx("%s: strlcpy", __func__);
191 	}
192 
193 	return sock;
194 }
195 
196 static struct socket *
197 sockets_conf_new_socket_fcgi(struct gotwebd *env, struct server *srv, int id,
198     struct address *a)
199 {
200 	struct socket *sock;
201 	struct address *acp;
202 	int n;
203 
204 	if ((sock = calloc(1, sizeof(*sock))) == NULL)
205 		fatalx("%s: calloc", __func__);
206 
207 	sock->conf.id = id;
208 	sock->fd = -1;
209 	sock->conf.af_type = a->ss.ss_family;
210 
211 	sock->conf.fcgi_socket_port = a->port;
212 
213 	n = snprintf(sock->conf.name, GOTWEBD_MAXTEXT, "%s_parent",
214 	    srv->name);
215 	if (n < 0 || (size_t)n >= GOTWEBD_MAXTEXT) {
216 		free(sock);
217 		fatalx("%s: snprintf", __func__);
218 	}
219 
220 	if (strlcpy(sock->conf.srv_name, srv->name,
221 	    sizeof(sock->conf.srv_name)) >= sizeof(sock->conf.srv_name)) {
222 		free(sock);
223 		fatalx("%s: strlcpy", __func__);
224 	}
225 
226 	acp = &sock->conf.addr;
227 
228 	memcpy(&acp->ss, &a->ss, sizeof(acp->ss));
229 	acp->ipproto = a->ipproto;
230 	acp->prefixlen = a->prefixlen;
231 	acp->port = a->port;
232 	if (strlen(a->ifname) != 0) {
233 		if (strlcpy(acp->ifname, a->ifname,
234 		    sizeof(acp->ifname)) >= sizeof(acp->ifname)) {
235 			fatalx("%s: interface name truncated",
236 			    __func__);
237 		}
238 	}
239 
240 	return (sock);
241 }
242 
243 static void
244 sockets_launch(void)
245 {
246 	struct socket *sock;
247 
248 	TAILQ_FOREACH(sock, &gotwebd_env->sockets, entry) {
249 		log_debug("%s: configuring socket %d (%d)", __func__,
250 		    sock->conf.id, sock->fd);
251 
252 		event_set(&sock->ev, sock->fd, EV_READ | EV_PERSIST,
253 		    sockets_socket_accept, sock);
254 
255 		if (event_add(&sock->ev, NULL))
256 			fatalx("event add sock");
257 
258 		evtimer_set(&sock->pause, sockets_accept_paused, sock);
259 
260 		log_debug("%s: running socket listener %d", __func__,
261 		    sock->conf.id);
262 	}
263 }
264 
265 static void
266 sockets_purge(struct gotwebd *env)
267 {
268 	struct socket *sock, *tsock;
269 
270 	/* shutdown and remove sockets */
271 	TAILQ_FOREACH_SAFE(sock, &env->sockets, entry, tsock) {
272 		if (event_initialized(&sock->ev))
273 			event_del(&sock->ev);
274 		if (evtimer_initialized(&sock->evt))
275 			evtimer_del(&sock->evt);
276 		if (evtimer_initialized(&sock->pause))
277 			evtimer_del(&sock->pause);
278 		if (sock->fd != -1)
279 			close(sock->fd);
280 		TAILQ_REMOVE(&env->sockets, sock, entry);
281 	}
282 }
283 
284 static int
285 sockets_dispatch_gotwebd(int fd, struct privsep_proc *p, struct imsg *imsg)
286 {
287 	struct privsep *ps = p->p_ps;
288 	int res = 0, cmd = 0, verbose;
289 
290 	switch (imsg->hdr.type) {
291 	case IMSG_CFG_SRV:
292 		config_getserver(gotwebd_env, imsg);
293 		break;
294 	case IMSG_CFG_SOCK:
295 		config_getsock(gotwebd_env, imsg);
296 		break;
297 	case IMSG_CFG_FD:
298 		config_getfd(gotwebd_env, imsg);
299 		break;
300 	case IMSG_CFG_DONE:
301 		config_getcfg(gotwebd_env, imsg);
302 		break;
303 	case IMSG_CTL_START:
304 		sockets_launch();
305 		break;
306 	case IMSG_CTL_VERBOSE:
307 		IMSG_SIZE_CHECK(imsg, &verbose);
308 		memcpy(&verbose, imsg->data, sizeof(verbose));
309 		log_setverbose(verbose);
310 		break;
311 	default:
312 		return -1;
313 	}
314 
315 	switch (cmd) {
316 	case 0:
317 		break;
318 	default:
319 		if (proc_compose_imsg(ps, PROC_GOTWEBD, -1, cmd,
320 		    imsg->hdr.peerid, -1, &res, sizeof(res)) == -1)
321 			return -1;
322 		break;
323 	}
324 
325 	return 0;
326 }
327 
328 static void
329 sockets_sighdlr(int sig, short event, void *arg)
330 {
331 	switch (sig) {
332 	case SIGHUP:
333 		log_info("%s: ignoring SIGHUP", __func__);
334 		break;
335 	case SIGPIPE:
336 		log_info("%s: ignoring SIGPIPE", __func__);
337 		break;
338 	case SIGUSR1:
339 		log_info("%s: ignoring SIGUSR1", __func__);
340 		break;
341 	case SIGCHLD:
342 		break;
343 	default:
344 		log_info("SIGNAL: %d", sig);
345 		fatalx("unexpected signal");
346 	}
347 }
348 
349 void
350 sockets_shutdown(void)
351 {
352 	struct server *srv, *tsrv;
353 	struct socket *sock, *tsock;
354 
355 	sockets_purge(gotwebd_env);
356 
357 	/* clean sockets */
358 	TAILQ_FOREACH_SAFE(sock, &gotwebd_env->sockets, entry, tsock) {
359 		TAILQ_REMOVE(&gotwebd_env->sockets, sock, entry);
360 		close(sock->fd);
361 		free(sock);
362 	}
363 
364 	/* clean servers */
365 	TAILQ_FOREACH_SAFE(srv, &gotwebd_env->servers, entry, tsrv)
366 		free(srv);
367 
368 	free(gotwebd_env);
369 }
370 
371 int
372 sockets_privinit(struct gotwebd *env, struct socket *sock)
373 {
374 	struct privsep *ps = env->gotwebd_ps;
375 
376 	if (sock->conf.af_type == AF_UNIX) {
377 		log_debug("%s: initializing unix socket %s", __func__,
378 		    sock->conf.unix_socket_name);
379 		sock->fd = sockets_unix_socket_listen(ps, sock);
380 		if (sock->fd == -1) {
381 			log_warnx("%s: create unix socket failed", __func__);
382 			return -1;
383 		}
384 	}
385 
386 	if (sock->conf.af_type == AF_INET || sock->conf.af_type == AF_INET6) {
387 		log_debug("%s: initializing %s FCGI socket on port %d for %s",
388 		    __func__, sock->conf.af_type == AF_INET ? "inet" : "inet6",
389 		    sock->conf.fcgi_socket_port, sock->conf.name);
390 		sock->fd = sockets_create_socket(&sock->conf.addr,
391 		    sock->conf.fcgi_socket_port);
392 		if (sock->fd == -1) {
393 			log_warnx("%s: create FCGI socket failed", __func__);
394 			return -1;
395 		}
396 	}
397 
398 	return 0;
399 }
400 
401 static int
402 sockets_unix_socket_listen(struct privsep *ps, struct socket *sock)
403 {
404 	struct gotwebd *env = ps->ps_env;
405 	struct sockaddr_un sun;
406 	struct socket *tsock;
407 	int u_fd = -1;
408 	mode_t old_umask, mode;
409 
410 	TAILQ_FOREACH(tsock, &env->sockets, entry) {
411 		if (strcmp(tsock->conf.unix_socket_name,
412 		    sock->conf.unix_socket_name) == 0 &&
413 		    tsock->fd != -1)
414 			return (tsock->fd);
415 	}
416 
417 	/* TA: FIXME:  this needs upstreaming. */
418 	int socket_flags = SOCK_STREAM | SOCK_NONBLOCK;
419 #ifdef SOCK_CLOEXEC
420 	socket_flags |= SOCK_CLOEXEC;
421 #endif
422 	u_fd = socket(AF_UNIX, socket_flags, 0);
423 	if (u_fd == -1) {
424 		log_warn("%s: socket", __func__);
425 		return -1;
426 	}
427 
428 	sun.sun_family = AF_UNIX;
429 	if (strlcpy(sun.sun_path, sock->conf.unix_socket_name,
430 	    sizeof(sun.sun_path)) >= sizeof(sun.sun_path)) {
431 		log_warn("%s: %s name too long", __func__,
432 		    sock->conf.unix_socket_name);
433 		close(u_fd);
434 		return -1;
435 	}
436 
437 	if (unlink(sock->conf.unix_socket_name) == -1) {
438 		if (errno != ENOENT) {
439 			log_warn("%s: unlink %s", __func__,
440 			    sock->conf.unix_socket_name);
441 			close(u_fd);
442 			return -1;
443 		}
444 	}
445 
446 	old_umask = umask(S_IXUSR|S_IXGRP|S_IWOTH|S_IROTH|S_IXOTH);
447 	mode = S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP;
448 
449 	if (bind(u_fd, (struct sockaddr *)&sun, sizeof(sun)) == -1) {
450 		log_warn("%s: bind: %s", __func__, sock->conf.unix_socket_name);
451 		close(u_fd);
452 		(void)umask(old_umask);
453 		return -1;
454 	}
455 
456 	(void)umask(old_umask);
457 
458 	if (chmod(sock->conf.unix_socket_name, mode) == -1) {
459 		log_warn("%s: chmod", __func__);
460 		close(u_fd);
461 		(void)unlink(sock->conf.unix_socket_name);
462 		return -1;
463 	}
464 
465 	if (chown(sock->conf.unix_socket_name, ps->ps_pw->pw_uid,
466 	    ps->ps_pw->pw_gid) == -1) {
467 		log_warn("%s: chown", __func__);
468 		close(u_fd);
469 		(void)unlink(sock->conf.unix_socket_name);
470 		return -1;
471 	}
472 
473 	if (listen(u_fd, SOCKS_BACKLOG) == -1) {
474 		log_warn("%s: listen", __func__);
475 		return -1;
476 	}
477 
478 	return u_fd;
479 }
480 
481 static int
482 sockets_create_socket(struct address *a, in_port_t port)
483 {
484 	struct addrinfo hints;
485 	int fd = -1, o_val = 1, flags;
486 
487 	memset(&hints, 0, sizeof(hints));
488 	hints.ai_family = AF_UNSPEC;
489 	hints.ai_socktype = SOCK_STREAM;
490 	hints.ai_flags |= AI_PASSIVE;
491 
492 	switch (a->ss.ss_family) {
493 	case AF_INET:
494 		((struct sockaddr_in *)(&a->ss))->sin_port = htons(port);
495 		break;
496 	case AF_INET6:
497 		((struct sockaddr_in6 *)(&a->ss))->sin6_port = htons(port);
498 		break;
499 	default:
500 		log_warnx("%s: unknown address family", __func__);
501 		return -1;
502 	}
503 
504 	fd = socket(a->ss.ss_family, hints.ai_socktype, a->ipproto);
505 	if (fd == -1)
506 		return -1;
507 
508 	log_debug("%s: opened socket (%d) for %s", __func__,
509 	    fd, a->ifname);
510 
511 	if (setsockopt(fd, SOL_SOCKET, SO_REUSEPORT, &o_val,
512 	    sizeof(int)) == -1) {
513 		log_warn("%s: setsockopt error", __func__);
514 		close(fd);
515 		return -1;
516 	}
517 
518 	/* non-blocking */
519 	flags = fcntl(fd, F_GETFL);
520 	flags |= O_NONBLOCK;
521 	if (fcntl(fd, F_SETFL, flags) == -1) {
522 		log_info("%s: could not enable non-blocking I/O", __func__);
523 		close(fd);
524 		return -1;
525 	}
526 
527 	if (bind(fd, (struct sockaddr *)&a->ss, SS_LEN(&a->ss)) == -1) {
528 		close(fd);
529 		log_info("%s: can't bind to port %d", __func__,
530 		    ntohs(port));
531 		return -1;
532 	}
533 
534 	if (listen(fd, SOMAXCONN) == -1) {
535 		log_warn("%s, unable to listen on socket", __func__);
536 		close(fd);
537 		return -1;
538 	}
539 
540 	return (fd);
541 }
542 
543 static int
544 sockets_accept_reserve(int sockfd, struct sockaddr *addr, socklen_t *addrlen,
545     int reserve, volatile int *counter)
546 {
547 	int ret;
548 
549 	if (getdtablecount() + reserve +
550 	    ((*counter + 1) * FD_NEEDED) >= getdtablesize()) {
551 		log_debug("inflight fds exceeded");
552 		errno = EMFILE;
553 		return -1;
554 	}
555 /* TA:  This needs fixing upstream. */
556 #ifdef __APPLE__
557 	ret = accept(sockfd, addr, addrlen);
558 #else
559 	ret = accept4(sockfd, addr, addrlen, SOCK_NONBLOCK | SOCK_CLOEXEC);
560 #endif
561 
562 	if (ret > -1) {
563 		(*counter)++;
564 		log_debug("inflight incremented, now %d", *counter);
565 	}
566 
567 	return ret;
568 }
569 
570 static void
571 sockets_accept_paused(int fd, short events, void *arg)
572 {
573 	struct socket *sock = (struct socket *)arg;
574 
575 	event_add(&sock->ev, NULL);
576 }
577 
578 void
579 sockets_socket_accept(int fd, short event, void *arg)
580 {
581 	struct socket *sock = (struct socket *)arg;
582 	struct sockaddr_storage ss;
583 	struct timeval backoff;
584 	struct request *c = NULL;
585 	socklen_t len;
586 	int s;
587 
588 	backoff.tv_sec = 1;
589 	backoff.tv_usec = 0;
590 
591 	event_add(&sock->ev, NULL);
592 	if (event & EV_TIMEOUT)
593 		return;
594 
595 	len = sizeof(ss);
596 
597 	s = sockets_accept_reserve(fd, (struct sockaddr *)&ss, &len,
598 	    FD_RESERVE, &cgi_inflight);
599 
600 	if (s == -1) {
601 		switch (errno) {
602 		case EINTR:
603 		case EWOULDBLOCK:
604 		case ECONNABORTED:
605 			return;
606 		case EMFILE:
607 		case ENFILE:
608 			event_del(&sock->ev);
609 			evtimer_add(&sock->pause, &backoff);
610 			return;
611 		default:
612 			log_warn("%s: accept", __func__);
613 		}
614 	}
615 
616 	if (client_cnt > GOTWEBD_MAXCLIENTS)
617 		goto err;
618 
619 	c = calloc(1, sizeof(struct request));
620 	if (c == NULL) {
621 		log_warn("%s", __func__);
622 		close(s);
623 		cgi_inflight--;
624 		return;
625 	}
626 
627 	c->fd = s;
628 	c->sock = sock;
629 	memcpy(c->priv_fd, sock->priv_fd, sizeof(c->priv_fd));
630 	c->buf_pos = 0;
631 	c->buf_len = 0;
632 	c->request_started = 0;
633 	c->sock->client_status = CLIENT_CONNECT;
634 
635 	event_set(&c->ev, s, EV_READ, fcgi_request, c);
636 	event_add(&c->ev, NULL);
637 
638 	evtimer_set(&c->tmo, fcgi_timeout, c);
639 	evtimer_add(&c->tmo, &timeout);
640 
641 	client_cnt++;
642 
643 	return;
644 err:
645 	cgi_inflight--;
646 	close(s);
647 	if (c != NULL)
648 		free(c);
649 }
650 
651 static void
652 sockets_rlimit(int maxfd)
653 {
654 	struct rlimit rl;
655 
656 	if (getrlimit(RLIMIT_NOFILE, &rl) == -1)
657 		fatal("%s: failed to get resource limit", __func__);
658 	log_debug("%s: max open files %llu", __func__,
659 	    (unsigned long long)rl.rlim_max);
660 
661 	/*
662 	 * Allow the maximum number of open file descriptors for this
663 	 * login class (which should be the class "daemon" by default).
664 	 */
665 	if (maxfd == -1)
666 		rl.rlim_cur = rl.rlim_max;
667 	else
668 		rl.rlim_cur = MAXIMUM(rl.rlim_max, (rlim_t)maxfd);
669 	if (setrlimit(RLIMIT_NOFILE, &rl) == -1)
670 		fatal("%s: failed to set resource limit", __func__);
671 }