1 /* $OpenBSD: proc.c,v 1.41 2021/12/04 06:52:58 florian Exp $ */
4 * Copyright (c) 2010 - 2016 Reyk Floeter <reyk@openbsd.org>
5 * Copyright (c) 2008 Pierre-Yves Ritschard <pyr@openbsd.org>
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.
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.
20 #include <sys/types.h>
21 #include <sys/queue.h>
23 #include <sys/socket.h>
45 void proc_exec(struct privsep *, struct privsep_proc *, unsigned int, int,
47 void proc_setup(struct privsep *, struct privsep_proc *, unsigned int);
48 void proc_open(struct privsep *, int, int);
49 void proc_accept(struct privsep *, int, enum privsep_procid,
51 void proc_close(struct privsep *);
52 void proc_shutdown(struct privsep_proc *);
53 void proc_sig_handler(int, short, void *);
54 void proc_range(struct privsep *, enum privsep_procid, int *, int *);
55 int proc_dispatch_null(int, struct privsep_proc *, struct imsg *);
58 proc_getid(struct privsep_proc *procs, unsigned int nproc,
59 const char *proc_name)
61 struct privsep_proc *p;
64 for (proc = 0; proc < nproc; proc++) {
66 if (strcmp(p->p_title, proc_name))
76 proc_exec(struct privsep *ps, struct privsep_proc *procs, unsigned int nproc,
77 int debug, int argc, char **argv)
79 unsigned int proc, nargc, i, proc_i;
81 struct privsep_proc *p;
85 /* Prepare the new process argv. */
86 nargv = calloc(argc + 5, sizeof(char *));
88 fatal("%s: calloc", __func__);
90 /* Copy call argument first. */
92 nargv[nargc++] = argv[0];
94 /* Set process name argument and save the position. */
95 nargv[nargc++] = "-P";
99 /* Point process instance arg to stack and copy the original args. */
100 nargv[nargc++] = "-I";
101 nargv[nargc++] = num;
102 for (i = 1; i < (unsigned int) argc; i++)
103 nargv[nargc++] = argv[i];
107 for (proc = 0; proc < nproc; proc++) {
110 /* Update args with process title. */
111 nargv[proc_i] = (char *)(uintptr_t)p->p_title;
113 /* Fire children processes. */
114 for (i = 0; i < ps->ps_instances[p->p_id]; i++) {
115 /* Update the process instance number. */
116 snprintf(num, sizeof(num), "%u", i);
118 fd = ps->ps_pipes[p->p_id][i].pp_pipes[PROC_PARENT][0];
119 ps->ps_pipes[p->p_id][i].pp_pipes[PROC_PARENT][0] = -1;
123 fatal("%s: fork", __func__);
126 /* First create a new session */
130 /* Prepare parent socket. */
131 if (fd != PROC_PARENT_SOCK_FILENO) {
132 if (dup2(fd, PROC_PARENT_SOCK_FILENO)
135 } else if (fcntl(fd, F_SETFD, 0) == -1)
138 /* Daemons detach from terminal. */
140 open(_PATH_DEVNULL, O_RDWR, 0)) != -1) {
141 (void)dup2(fd, STDIN_FILENO);
142 (void)dup2(fd, STDOUT_FILENO);
143 (void)dup2(fd, STDERR_FILENO);
148 execvp(argv[0], nargv);
149 fatal("%s: execvp", __func__);
152 /* Close child end. */
162 proc_connect(struct privsep *ps)
165 unsigned int src, dst, inst;
167 /* Don't distribute any sockets if we are not really going to run. */
171 for (dst = 0; dst < PROC_MAX; dst++) {
172 /* We don't communicate with ourselves. */
173 if (dst == PROC_PARENT)
176 for (inst = 0; inst < ps->ps_instances[dst]; inst++) {
177 iev = &ps->ps_ievs[dst][inst];
178 imsg_init(&iev->ibuf, ps->ps_pp->pp_pipes[dst][inst]);
179 event_set(&iev->ev, iev->ibuf.fd, iev->events,
180 iev->handler, iev->data);
181 event_add(&iev->ev, NULL);
185 /* Distribute the socketpair()s for everyone. */
186 for (src = 0; src < PROC_MAX; src++)
187 for (dst = src; dst < PROC_MAX; dst++) {
188 /* Parent already distributed its fds. */
189 if (src == PROC_PARENT || dst == PROC_PARENT)
192 proc_open(ps, src, dst);
197 proc_init(struct privsep *ps, struct privsep_proc *procs, unsigned int nproc,
198 int debug, int argc, char **argv, enum privsep_procid proc_id)
200 struct privsep_proc *p = NULL;
201 struct privsep_pipes *pa, *pb;
206 /* Don't initiate anything if we are not really going to run. */
210 if (proc_id == PROC_PARENT) {
211 privsep_process = PROC_PARENT;
212 proc_setup(ps, procs, nproc);
215 * Create the children sockets so we can use them
216 * to distribute the rest of the socketpair()s using
217 * proc_connect() later.
219 for (dst = 0; dst < PROC_MAX; dst++) {
220 /* Don't create socket for ourselves. */
221 if (dst == PROC_PARENT)
224 for (proc = 0; proc < ps->ps_instances[dst]; proc++) {
225 pa = &ps->ps_pipes[PROC_PARENT][0];
226 pb = &ps->ps_pipes[dst][proc];
227 if (socketpair(AF_UNIX,
228 SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC,
229 PF_UNSPEC, fds) == -1)
230 fatal("%s: socketpair", __func__);
232 pa->pp_pipes[dst][proc] = fds[0];
233 pb->pp_pipes[PROC_PARENT][0] = fds[1];
238 proc_exec(ps, procs, nproc, debug, argc, argv);
242 /* Initialize a child */
243 for (proc = 0; proc < nproc; proc++) {
244 if (procs[proc].p_id != proc_id)
249 if (p == NULL || p->p_init == NULL)
250 fatalx("%s: process %d missing process initialization",
255 fatalx("failed to initiate child process");
259 proc_accept(struct privsep *ps, int fd, enum privsep_procid dst,
262 struct privsep_pipes *pp = ps->ps_pp;
265 if (ps->ps_ievs[dst] == NULL) {
267 log_debug("%s: %s src %d %d to dst %d %d not connected",
268 __func__, ps->ps_title[privsep_process],
269 privsep_process, ps->ps_instance + 1,
276 if (pp->pp_pipes[dst][n] != -1) {
277 log_warnx("%s: duplicated descriptor", __func__);
281 pp->pp_pipes[dst][n] = fd;
283 iev = &ps->ps_ievs[dst][n];
284 imsg_init(&iev->ibuf, fd);
285 event_set(&iev->ev, iev->ibuf.fd, iev->events, iev->handler, iev->data);
286 event_add(&iev->ev, NULL);
290 proc_setup(struct privsep *ps, struct privsep_proc *procs, unsigned int nproc)
292 unsigned int i, j, src, dst, id;
293 struct privsep_pipes *pp;
295 /* Initialize parent title, ps_instances and procs. */
296 ps->ps_title[PROC_PARENT] = "parent";
298 for (src = 0; src < PROC_MAX; src++)
299 /* Default to 1 process instance */
300 if (ps->ps_instances[src] < 1)
301 ps->ps_instances[src] = 1;
303 for (src = 0; src < nproc; src++) {
304 procs[src].p_ps = ps;
305 if (procs[src].p_cb == NULL)
306 procs[src].p_cb = proc_dispatch_null;
308 id = procs[src].p_id;
309 ps->ps_title[id] = procs[src].p_title;
310 if ((ps->ps_ievs[id] = calloc(ps->ps_instances[id],
311 sizeof(struct imsgev))) == NULL)
312 fatal("%s: calloc", __func__);
314 /* With this set up, we are ready to call imsg_init(). */
315 for (i = 0; i < ps->ps_instances[id]; i++) {
316 ps->ps_ievs[id][i].handler = proc_dispatch;
317 ps->ps_ievs[id][i].events = EV_READ;
318 ps->ps_ievs[id][i].proc = &procs[src];
319 ps->ps_ievs[id][i].data = &ps->ps_ievs[id][i];
324 * Allocate pipes for all process instances (incl. parent)
326 * - ps->ps_pipes: N:M mapping
327 * N source processes connected to M destination processes:
328 * [src][instances][dst][instances], for example
329 * [PROC_RELAY][3][PROC_CA][3]
331 * - ps->ps_pp: per-process 1:M part of ps->ps_pipes
332 * Each process instance has a destination array of socketpair fds:
333 * [dst][instances], for example
336 for (src = 0; src < PROC_MAX; src++) {
337 /* Allocate destination array for each process */
338 if ((ps->ps_pipes[src] = calloc(ps->ps_instances[src],
339 sizeof(struct privsep_pipes))) == NULL)
340 fatal("%s: calloc", __func__);
342 for (i = 0; i < ps->ps_instances[src]; i++) {
343 pp = &ps->ps_pipes[src][i];
345 for (dst = 0; dst < PROC_MAX; dst++) {
346 /* Allocate maximum fd integers */
347 if ((pp->pp_pipes[dst] =
348 calloc(ps->ps_instances[dst],
349 sizeof(int))) == NULL)
350 fatal("%s: calloc", __func__);
352 /* Mark fd as unused */
353 for (j = 0; j < ps->ps_instances[dst]; j++)
354 pp->pp_pipes[dst][j] = -1;
359 ps->ps_pp = &ps->ps_pipes[privsep_process][ps->ps_instance];
363 proc_kill(struct privsep *ps)
369 if (privsep_process != PROC_PARENT)
375 pid = waitpid(WAIT_ANY, &status, 0);
379 if (WIFSIGNALED(status)) {
380 len = asprintf(&cause, "terminated; signal %d",
382 } else if (WIFEXITED(status)) {
383 if (WEXITSTATUS(status) != 0)
384 len = asprintf(&cause, "exited abnormally");
391 /* child exited OK, don't print a warning message */
392 } else if (len != -1) {
393 log_warnx("lost child: pid %u %s", pid, cause);
396 log_warnx("lost child: pid %u", pid);
397 } while (pid != -1 || errno == EINTR);
401 proc_open(struct privsep *ps, int src, int dst)
403 struct privsep_pipes *pa, *pb;
404 struct privsep_fd pf;
408 /* Exchange pipes between process. */
409 for (i = 0; i < ps->ps_instances[src]; i++) {
410 for (j = 0; j < ps->ps_instances[dst]; j++) {
411 /* Don't create sockets for ourself. */
412 if (src == dst && i == j)
415 /* Proxies don't talk to each other. */
416 if (src == PROC_PROXY && dst == PROC_PROXY)
419 pa = &ps->ps_pipes[src][i];
420 pb = &ps->ps_pipes[dst][j];
421 if (socketpair(AF_UNIX,
422 SOCK_STREAM | SOCK_NONBLOCK | SOCK_CLOEXEC,
423 PF_UNSPEC, fds) == -1)
424 fatal("%s: socketpair", __func__);
426 pa->pp_pipes[dst][j] = fds[0];
427 pb->pp_pipes[src][i] = fds[1];
431 if (proc_compose_imsg(ps, dst, j, IMSG_CTL_PROCFD,
432 -1, pb->pp_pipes[src][i], &pf, sizeof(pf)) == -1)
433 fatal("%s: proc_compose_imsg", __func__);
437 if (proc_compose_imsg(ps, src, i, IMSG_CTL_PROCFD,
438 -1, pa->pp_pipes[dst][j], &pf, sizeof(pf)) == -1)
439 fatal("%s: proc_compose_imsg", __func__);
442 * We have to flush to send the descriptors and close
443 * them to avoid the fd ramp on startup.
445 if (proc_flush_imsg(ps, src, i) == -1 ||
446 proc_flush_imsg(ps, dst, j) == -1)
447 fatal("%s: imsg_flush", __func__);
453 proc_close(struct privsep *ps)
456 struct privsep_pipes *pp;
463 for (dst = 0; dst < PROC_MAX; dst++) {
464 if (ps->ps_ievs[dst] == NULL)
467 for (n = 0; n < ps->ps_instances[dst]; n++) {
468 if (pp->pp_pipes[dst][n] == -1)
471 /* Cancel the fd, close and invalidate the fd */
472 event_del(&(ps->ps_ievs[dst][n].ev));
473 imsg_clear(&(ps->ps_ievs[dst][n].ibuf));
474 close(pp->pp_pipes[dst][n]);
475 pp->pp_pipes[dst][n] = -1;
477 free(ps->ps_ievs[dst]);
482 proc_shutdown(struct privsep_proc *p)
484 struct privsep *ps = p->p_ps;
486 if (p->p_shutdown != NULL)
491 log_info("%s exiting, pid %d", p->p_title, getpid());
497 proc_sig_handler(int sig, short event, void *arg)
499 struct privsep_proc *p = arg;
511 fatalx("%s: unexpected signal", __func__);
517 proc_run(struct privsep *ps, struct privsep_proc *p,
518 struct privsep_proc *procs, unsigned int nproc,
519 void (*run)(struct privsep *, struct privsep_proc *, void *), void *arg)
524 log_procinit(p->p_title);
526 /* Set the process group of the current process */
529 /* Use non-standard user */
535 /* Change root directory */
536 if (p->p_chroot != NULL)
541 if (chroot(root) == -1)
542 fatal("%s: chroot", __func__);
543 if (chdir("/") == -1)
544 fatal("%s: chdir(\"/\")", __func__);
546 privsep_process = p->p_id;
548 setproctitle("%s", p->p_title);
550 if (setgroups(1, &pw->pw_gid) ||
551 setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) ||
552 setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid))
553 fatal("%s: cannot drop privileges", __func__);
557 signal(SIGPIPE, SIG_IGN);
559 signal_set(&ps->ps_evsigint, SIGINT, proc_sig_handler, p);
560 signal_set(&ps->ps_evsigterm, SIGTERM, proc_sig_handler, p);
561 signal_set(&ps->ps_evsigchld, SIGCHLD, proc_sig_handler, p);
562 signal_set(&ps->ps_evsighup, SIGHUP, proc_sig_handler, p);
564 signal_add(&ps->ps_evsigint, NULL);
565 signal_add(&ps->ps_evsigterm, NULL);
566 signal_add(&ps->ps_evsigchld, NULL);
567 signal_add(&ps->ps_evsighup, NULL);
569 proc_setup(ps, procs, nproc);
570 proc_accept(ps, PROC_PARENT_SOCK_FILENO, PROC_PARENT, 0);
572 log_debug("%s: %s %d/%d, pid %d", __func__, p->p_title,
573 ps->ps_instance + 1, ps->ps_instances[p->p_id], getpid());
584 proc_dispatch(int fd, short event, void *arg)
586 struct imsgev *iev = arg;
587 struct privsep_proc *p = iev->proc;
588 struct privsep *ps = p->p_ps;
589 struct imsgbuf *ibuf;
593 struct privsep_fd pf;
595 title = ps->ps_title[privsep_process];
598 if (event & EV_READ) {
599 if ((n = imsg_read(ibuf)) == -1 && errno != EAGAIN)
600 fatal("%s: imsg_read", __func__);
602 /* this pipe is dead, so remove the event handler */
604 event_loopexit(NULL);
609 if (event & EV_WRITE) {
610 if ((n = msgbuf_write(&ibuf->w)) == -1 && errno != EAGAIN)
611 fatal("%s: msgbuf_write", __func__);
613 /* this pipe is dead, so remove the event handler */
615 event_loopexit(NULL);
621 if ((n = imsg_get(ibuf, &imsg)) == -1)
622 fatal("%s: imsg_get", __func__);
627 log_debug("%s: %s %d got imsg %d peerid %d from %s %d",
628 __func__, title, ps->ps_instance + 1,
629 imsg.hdr.type, imsg.hdr.peerid, p->p_title, imsg.hdr.pid);
633 * Check the message with the program callback
635 if ((p->p_cb)(fd, p, &imsg) == 0) {
636 /* Message was handled by the callback, continue */
642 * Generic message handling
644 switch (imsg.hdr.type) {
645 case IMSG_CTL_PROCFD:
646 IMSG_SIZE_CHECK(&imsg, &pf);
647 memcpy(&pf, imsg.data, sizeof(pf));
648 proc_accept(ps, imsg.fd, pf.pf_procid,
652 fatalx("%s: %s %d got invalid imsg %d peerid %d "
654 __func__, title, ps->ps_instance + 1,
655 imsg.hdr.type, imsg.hdr.peerid,
656 p->p_title, imsg.hdr.pid);
664 proc_dispatch_null(int fd, struct privsep_proc *p, struct imsg *imsg)
670 * imsg helper functions
674 imsg_event_add(struct imsgev *iev)
676 if (iev->handler == NULL) {
677 imsg_flush(&iev->ibuf);
681 iev->events = EV_READ;
682 if (iev->ibuf.w.queued)
683 iev->events |= EV_WRITE;
686 event_set(&iev->ev, iev->ibuf.fd, iev->events, iev->handler, iev->data);
687 event_add(&iev->ev, NULL);
691 imsg_compose_event(struct imsgev *iev, uint16_t type, uint32_t peerid,
692 pid_t pid, int fd, void *data, uint16_t datalen)
696 if ((ret = imsg_compose(&iev->ibuf, type, peerid,
697 pid, fd, data, datalen)) == -1)
704 imsg_composev_event(struct imsgev *iev, uint16_t type, uint32_t peerid,
705 pid_t pid, int fd, const struct iovec *iov, int iovcnt)
709 if ((ret = imsg_composev(&iev->ibuf, type, peerid,
710 pid, fd, iov, iovcnt)) == -1)
717 proc_range(struct privsep *ps, enum privsep_procid id, int *n, int *m)
720 /* Use a range of all target instances */
722 *m = ps->ps_instances[id];
724 /* Use only a single slot of the specified peer process */
730 proc_compose_imsg(struct privsep *ps, enum privsep_procid id, int n,
731 uint16_t type, uint32_t peerid, int fd, void *data, uint16_t datalen)
735 proc_range(ps, id, &n, &m);
737 if (imsg_compose_event(&ps->ps_ievs[id][n],
738 type, peerid, ps->ps_instance + 1, fd, data, datalen) == -1)
746 proc_compose(struct privsep *ps, enum privsep_procid id,
747 uint16_t type, void *data, uint16_t datalen)
749 return (proc_compose_imsg(ps, id, -1, type, -1, -1, data, datalen));
753 proc_composev_imsg(struct privsep *ps, enum privsep_procid id, int n,
754 uint16_t type, uint32_t peerid, int fd, const struct iovec *iov, int iovcnt)
758 proc_range(ps, id, &n, &m);
760 if (imsg_composev_event(&ps->ps_ievs[id][n],
761 type, peerid, ps->ps_instance + 1, fd, iov, iovcnt) == -1)
768 proc_composev(struct privsep *ps, enum privsep_procid id,
769 uint16_t type, const struct iovec *iov, int iovcnt)
771 return (proc_composev_imsg(ps, id, -1, type, -1, -1, iov, iovcnt));
775 proc_forward_imsg(struct privsep *ps, struct imsg *imsg,
776 enum privsep_procid id, int n)
778 return (proc_compose_imsg(ps, id, n, imsg->hdr.type,
779 imsg->hdr.peerid, imsg->fd, imsg->data, IMSG_DATA_SIZE(imsg)));
783 proc_ibuf(struct privsep *ps, enum privsep_procid id, int n)
787 proc_range(ps, id, &n, &m);
788 return (&ps->ps_ievs[id][n].ibuf);
792 proc_iev(struct privsep *ps, enum privsep_procid id, int n)
796 proc_range(ps, id, &n, &m);
797 return (&ps->ps_ievs[id][n]);
800 /* This function should only be called with care as it breaks async I/O */
802 proc_flush_imsg(struct privsep *ps, enum privsep_procid id, int n)
804 struct imsgbuf *ibuf;
807 proc_range(ps, id, &n, &m);
809 if ((ibuf = proc_ibuf(ps, id, n)) == NULL)
812 ret = imsg_flush(ibuf);
813 } while (ret == -1 && errno == EAGAIN);
816 imsg_event_add(&ps->ps_ievs[id][n]);