2 * Copyright (c) 2010 - 2016 Reyk Floeter <reyk@openbsd.org>
3 * Copyright (c) 2008 Pierre-Yves Ritschard <pyr@openbsd.org>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include "got_compat.h"
19 #include <sys/types.h>
20 #include <sys/queue.h>
21 #include <sys/socket.h>
36 void proc_exec(struct privsep
*, struct privsep_proc
*, unsigned int,
38 void proc_setup(struct privsep
*, struct privsep_proc
*, unsigned int);
39 void proc_open(struct privsep
*, int, int);
40 void proc_accept(struct privsep
*, int, enum privsep_procid
,
42 void proc_close(struct privsep
*);
43 int proc_ispeer(struct privsep_proc
*, unsigned int, enum privsep_procid
);
44 void proc_shutdown(struct privsep_proc
*);
45 void proc_sig_handler(int, short, void *);
46 int proc_dispatch_null(int, struct privsep_proc
*, struct imsg
*);
48 enum privsep_procid privsep_process
;
51 proc_ispeer(struct privsep_proc
*procs
, unsigned int nproc
,
52 enum privsep_procid type
)
56 for (i
= 0; i
< nproc
; i
++)
57 if (procs
[i
].p_id
== type
)
64 proc_getid(struct privsep_proc
*procs
, unsigned int nproc
,
65 const char *proc_name
)
67 struct privsep_proc
*p
;
70 for (proc
= 0; proc
< nproc
; proc
++) {
72 if (strcmp(p
->p_title
, proc_name
))
82 proc_exec(struct privsep
*ps
, struct privsep_proc
*procs
, unsigned int nproc
,
83 int argc
, char **argv
)
85 unsigned int proc
, nargc
, i
, proc_i
;
87 struct privsep_proc
*p
;
91 /* Prepare the new process argv. */
92 nargv
= calloc(argc
+ 5, sizeof(char *));
94 fatal("%s: calloc", __func__
);
96 /* Copy call argument first. */
98 nargv
[nargc
++] = argv
[0];
100 /* Set process name argument and save the position. */
101 nargv
[nargc
] = strdup("-P");
102 if (nargv
[nargc
] == NULL
)
103 fatal("%s: strdup", __func__
);
108 /* Point process instance arg to stack and copy the original args. */
109 nargv
[nargc
] = strdup("-I");
110 if (nargv
[nargc
] == NULL
)
111 fatal("%s: strdup", __func__
);
113 nargv
[nargc
++] = num
;
114 for (i
= 1; i
< (unsigned int) argc
; i
++)
115 nargv
[nargc
++] = argv
[i
];
119 for (proc
= 0; proc
< nproc
; proc
++) {
122 /* Update args with process title. */
123 nargv
[proc_i
] = (char *)(uintptr_t)p
->p_title
;
125 /* Fire children processes. */
126 for (i
= 0; i
< ps
->ps_instances
[p
->p_id
]; i
++) {
127 /* Update the process instance number. */
128 snprintf(num
, sizeof(num
), "%u", i
);
130 fd
= ps
->ps_pipes
[p
->p_id
][i
].pp_pipes
[PROC_GOTWEBD
][0];
131 ps
->ps_pipes
[p
->p_id
][i
].pp_pipes
[PROC_GOTWEBD
][0] = -1;
135 fatal("%s: fork", __func__
);
138 /* First create a new session */
142 /* Prepare parent socket. */
143 if (fd
!= PROC_GOTWEBD_SOCK_FILENO
) {
144 if (dup2(fd
, PROC_GOTWEBD_SOCK_FILENO
)
147 } else if (fcntl(fd
, F_SETFD
, 0) == -1)
150 execvp(argv
[0], nargv
);
151 fatal("%s: execvp", __func__
);
154 /* Close child end. */
165 proc_connect(struct privsep
*ps
)
168 unsigned int src
, dst
, inst
;
170 /* Don't distribute any sockets if we are not really going to run. */
174 for (dst
= 0; dst
< PROC_MAX
; dst
++) {
175 /* We don't communicate with ourselves. */
176 if (dst
== PROC_GOTWEBD
)
179 for (inst
= 0; inst
< ps
->ps_instances
[dst
]; inst
++) {
180 iev
= &ps
->ps_ievs
[dst
][inst
];
181 imsg_init(&iev
->ibuf
, ps
->ps_pp
->pp_pipes
[dst
][inst
]);
182 event_set(&iev
->ev
, iev
->ibuf
.fd
, iev
->events
,
183 iev
->handler
, iev
->data
);
184 event_add(&iev
->ev
, NULL
);
188 /* Distribute the socketpair()s for everyone. */
189 for (src
= 0; src
< PROC_MAX
; src
++)
190 for (dst
= src
; dst
< PROC_MAX
; dst
++) {
191 /* Parent already distributed its fds. */
192 if (src
== PROC_GOTWEBD
|| dst
== PROC_GOTWEBD
)
195 proc_open(ps
, src
, dst
);
200 proc_init(struct privsep
*ps
, struct privsep_proc
*procs
, unsigned int nproc
,
201 int argc
, char **argv
, enum privsep_procid proc_id
)
203 struct privsep_proc
*p
= NULL
;
204 struct privsep_pipes
*pa
, *pb
;
209 /* Don't initiate anything if we are not really going to run. */
213 if (proc_id
== PROC_GOTWEBD
) {
214 privsep_process
= PROC_GOTWEBD
;
215 proc_setup(ps
, procs
, nproc
);
218 * Create the children sockets so we can use them
219 * to distribute the rest of the socketpair()s using
220 * proc_connect() later.
222 for (dst
= 0; dst
< PROC_MAX
; dst
++) {
223 /* Don't create socket for ourselves. */
224 if (dst
== PROC_GOTWEBD
)
227 for (proc
= 0; proc
< ps
->ps_instances
[dst
]; proc
++) {
228 pa
= &ps
->ps_pipes
[PROC_GOTWEBD
][0];
229 pb
= &ps
->ps_pipes
[dst
][proc
];
230 int sock_flags
= SOCK_STREAM
| SOCK_NONBLOCK
;
232 sock_flags
|= SOCK_CLOEXEC
;
234 if (socketpair(AF_UNIX
, sock_flags
,
235 PF_UNSPEC
, fds
) == -1)
236 fatal("%s: socketpair", __func__
);
238 pa
->pp_pipes
[dst
][proc
] = fds
[0];
239 pb
->pp_pipes
[PROC_GOTWEBD
][0] = fds
[1];
244 proc_exec(ps
, procs
, nproc
, argc
, argv
);
248 /* Initialize a child */
249 for (proc
= 0; proc
< nproc
; proc
++) {
250 if (procs
[proc
].p_id
!= proc_id
)
255 if (p
== NULL
|| p
->p_init
== NULL
)
256 fatalx("%s: process %d missing process initialization",
261 fatalx("failed to initiate child process");
265 proc_accept(struct privsep
*ps
, int fd
, enum privsep_procid dst
,
268 struct privsep_pipes
*pp
= ps
->ps_pp
;
271 if (ps
->ps_ievs
[dst
] == NULL
) {
273 log_debug("%s: %s src %d %d to dst %d %d not connected",
274 __func__
, ps
->ps_title
[privsep_process
],
275 privsep_process
, ps
->ps_instance
+ 1,
282 if (pp
->pp_pipes
[dst
][n
] != -1) {
283 log_warnx("%s: duplicated descriptor", __func__
);
287 pp
->pp_pipes
[dst
][n
] = fd
;
289 iev
= &ps
->ps_ievs
[dst
][n
];
290 imsg_init(&iev
->ibuf
, fd
);
291 event_set(&iev
->ev
, iev
->ibuf
.fd
, iev
->events
, iev
->handler
, iev
->data
);
292 event_add(&iev
->ev
, NULL
);
296 proc_setup(struct privsep
*ps
, struct privsep_proc
*procs
, unsigned int nproc
)
298 unsigned int i
, j
, src
, dst
, id
;
299 struct privsep_pipes
*pp
;
301 /* Initialize parent title, ps_instances and procs. */
302 ps
->ps_title
[PROC_GOTWEBD
] = "parent";
304 for (src
= 0; src
< PROC_MAX
; src
++)
305 /* Default to 1 process instance */
306 if (ps
->ps_instances
[src
] < 1)
307 ps
->ps_instances
[src
] = 1;
309 for (src
= 0; src
< nproc
; src
++) {
310 procs
[src
].p_ps
= ps
;
311 if (procs
[src
].p_cb
== NULL
)
312 procs
[src
].p_cb
= proc_dispatch_null
;
314 id
= procs
[src
].p_id
;
315 ps
->ps_title
[id
] = procs
[src
].p_title
;
316 ps
->ps_ievs
[id
] = calloc(ps
->ps_instances
[id
],
317 sizeof(struct imsgev
));
318 if (ps
->ps_ievs
[id
] == NULL
)
319 fatal("%s: calloc", __func__
);
321 /* With this set up, we are ready to call imsg_init(). */
322 for (i
= 0; i
< ps
->ps_instances
[id
]; i
++) {
323 ps
->ps_ievs
[id
][i
].handler
= proc_dispatch
;
324 ps
->ps_ievs
[id
][i
].events
= EV_READ
;
325 ps
->ps_ievs
[id
][i
].proc
= &procs
[src
];
326 ps
->ps_ievs
[id
][i
].data
= &ps
->ps_ievs
[id
][i
];
331 * Allocate pipes for all process instances (incl. parent)
333 * - ps->ps_pipes: N:M mapping
334 * N source processes connected to M destination processes:
335 * [src][instances][dst][instances], for example
336 * [PROC_RELAY][3][PROC_CA][3]
338 * - ps->ps_pp: per-process 1:M part of ps->ps_pipes
339 * Each process instance has a destination array of socketpair fds:
340 * [dst][instances], for example
343 for (src
= 0; src
< PROC_MAX
; src
++) {
344 /* Allocate destination array for each process */
345 ps
->ps_pipes
[src
] = calloc(ps
->ps_instances
[src
],
346 sizeof(struct privsep_pipes
));
347 if (ps
->ps_pipes
[src
] == NULL
)
348 fatal("%s: calloc", __func__
);
350 for (i
= 0; i
< ps
->ps_instances
[src
]; i
++) {
351 pp
= &ps
->ps_pipes
[src
][i
];
353 for (dst
= 0; dst
< PROC_MAX
; dst
++) {
354 /* Allocate maximum fd integers */
356 calloc(ps
->ps_instances
[dst
],
358 if (pp
->pp_pipes
[dst
] == NULL
)
359 fatal("%s: calloc", __func__
);
361 /* Mark fd as unused */
362 for (j
= 0; j
< ps
->ps_instances
[dst
]; j
++)
363 pp
->pp_pipes
[dst
][j
] = -1;
368 ps
->ps_pp
= &ps
->ps_pipes
[privsep_process
][ps
->ps_instance
];
372 proc_kill(struct privsep
*ps
)
378 if (privsep_process
!= PROC_GOTWEBD
)
384 pid
= waitpid(WAIT_ANY
, &status
, 0);
388 if (WIFSIGNALED(status
)) {
389 len
= asprintf(&cause
, "terminated; signal %d",
391 } else if (WIFEXITED(status
)) {
392 if (WEXITSTATUS(status
) != 0)
393 len
= asprintf(&cause
, "exited abnormally");
400 /* child exited OK, don't print a warning message */
401 } else if (len
!= -1) {
402 log_warnx("lost child: pid %u %s", pid
, cause
);
405 log_warnx("lost child: pid %u", pid
);
406 } while (pid
!= -1 || (pid
== -1 && errno
== EINTR
));
410 proc_open(struct privsep
*ps
, int src
, int dst
)
412 struct privsep_pipes
*pa
, *pb
;
413 struct privsep_fd pf
;
417 /* Exchange pipes between process. */
418 for (i
= 0; i
< ps
->ps_instances
[src
]; i
++) {
419 for (j
= 0; j
< ps
->ps_instances
[dst
]; j
++) {
420 /* Don't create sockets for ourself. */
421 if (src
== dst
&& i
== j
)
424 pa
= &ps
->ps_pipes
[src
][i
];
425 pb
= &ps
->ps_pipes
[dst
][j
];
426 int sock_flags
= SOCK_STREAM
| SOCK_NONBLOCK
;
428 sock_flags
|= SOCK_CLOEXEC
;
430 if (socketpair(AF_UNIX
, sock_flags
,
431 PF_UNSPEC
, fds
) == -1)
432 fatal("%s: socketpair", __func__
);
434 pa
->pp_pipes
[dst
][j
] = fds
[0];
435 pb
->pp_pipes
[src
][i
] = fds
[1];
439 if (proc_compose_imsg(ps
, dst
, j
, IMSG_CTL_PROCFD
,
440 -1, pb
->pp_pipes
[src
][i
], &pf
, sizeof(pf
)) == -1)
441 fatal("%s: proc_compose_imsg", __func__
);
445 if (proc_compose_imsg(ps
, src
, i
, IMSG_CTL_PROCFD
,
446 -1, pa
->pp_pipes
[dst
][j
], &pf
, sizeof(pf
)) == -1)
447 fatal("%s: proc_compose_imsg", __func__
);
450 * We have to flush to send the descriptors and close
451 * them to avoid the fd ramp on startup.
453 if (proc_flush_imsg(ps
, src
, i
) == -1 ||
454 proc_flush_imsg(ps
, dst
, j
) == -1)
455 fatal("%s: imsg_flush", __func__
);
461 proc_close(struct privsep
*ps
)
464 struct privsep_pipes
*pp
;
471 for (dst
= 0; dst
< PROC_MAX
; dst
++) {
472 if (ps
->ps_ievs
[dst
] == NULL
)
475 for (n
= 0; n
< ps
->ps_instances
[dst
]; n
++) {
476 if (pp
->pp_pipes
[dst
][n
] == -1)
479 /* Cancel the fd, close and invalidate the fd */
480 event_del(&(ps
->ps_ievs
[dst
][n
].ev
));
481 imsg_clear(&(ps
->ps_ievs
[dst
][n
].ibuf
));
482 close(pp
->pp_pipes
[dst
][n
]);
483 pp
->pp_pipes
[dst
][n
] = -1;
485 free(ps
->ps_ievs
[dst
]);
490 proc_shutdown(struct privsep_proc
*p
)
492 struct privsep
*ps
= p
->p_ps
;
494 if (p
->p_shutdown
!= NULL
)
499 log_info("%s, %s exiting, pid %d", getprogname(), p
->p_title
, getpid());
505 proc_sig_handler(int sig
, short event
, void *arg
)
507 struct privsep_proc
*p
= arg
;
521 fatalx("proc_sig_handler: unexpected signal");
527 proc_run(struct privsep
*ps
, struct privsep_proc
*p
,
528 struct privsep_proc
*procs
, unsigned int nproc
,
529 void (*run
)(struct privsep
*, struct privsep_proc
*, void *), void *arg
)
534 log_procinit(p
->p_title
);
536 /* Set the process group of the current process */
539 /* Use non-standard user */
545 /* Change root directory */
546 if (p
->p_chroot
!= NULL
)
551 if (chroot(root
) == -1)
552 fatal("proc_run: chroot");
553 if (chdir("/") == -1)
554 fatal("proc_run: chdir(\"/\")");
556 privsep_process
= p
->p_id
;
558 setproctitle("%s", p
->p_title
);
560 if (setgroups(1, &pw
->pw_gid
) ||
561 setresgid(pw
->pw_gid
, pw
->pw_gid
, pw
->pw_gid
) ||
562 setresuid(pw
->pw_uid
, pw
->pw_uid
, pw
->pw_uid
))
563 fatal("proc_run: cannot drop privileges");
567 signal_set(&ps
->ps_evsigint
, SIGINT
, proc_sig_handler
, p
);
568 signal_set(&ps
->ps_evsigterm
, SIGTERM
, proc_sig_handler
, p
);
569 signal_set(&ps
->ps_evsigchld
, SIGCHLD
, proc_sig_handler
, p
);
570 signal_set(&ps
->ps_evsighup
, SIGHUP
, proc_sig_handler
, p
);
571 signal_set(&ps
->ps_evsigpipe
, SIGPIPE
, proc_sig_handler
, p
);
572 signal_set(&ps
->ps_evsigusr1
, SIGUSR1
, proc_sig_handler
, p
);
574 signal_add(&ps
->ps_evsigint
, NULL
);
575 signal_add(&ps
->ps_evsigterm
, NULL
);
576 signal_add(&ps
->ps_evsigchld
, NULL
);
577 signal_add(&ps
->ps_evsighup
, NULL
);
578 signal_add(&ps
->ps_evsigpipe
, NULL
);
579 signal_add(&ps
->ps_evsigusr1
, NULL
);
581 proc_setup(ps
, procs
, nproc
);
582 proc_accept(ps
, PROC_GOTWEBD_SOCK_FILENO
, PROC_GOTWEBD
, 0);
584 DPRINTF("%s: %s %d/%d, pid %d", __func__
, p
->p_title
,
585 ps
->ps_instance
+ 1, ps
->ps_instances
[p
->p_id
], getpid());
596 proc_dispatch(int fd
, short event
, void *arg
)
598 struct imsgev
*iev
= arg
;
599 struct privsep_proc
*p
= iev
->proc
;
600 struct privsep
*ps
= p
->p_ps
;
601 struct imsgbuf
*ibuf
;
606 struct privsep_fd pf
;
608 title
= ps
->ps_title
[privsep_process
];
611 if (event
& EV_READ
) {
613 if (n
== -1 && errno
!= EAGAIN
)
614 fatal("%s: imsg_read", __func__
);
616 /* this pipe is dead, so remove the event handler */
618 event_loopexit(NULL
);
623 if (event
& EV_WRITE
) {
624 n
= msgbuf_write(&ibuf
->w
);
625 if (n
== -1 && errno
!= EAGAIN
)
626 fatal("%s: msgbuf_write", __func__
);
628 /* this pipe is dead, so remove the event handler */
630 event_loopexit(NULL
);
636 n
= imsg_get(ibuf
, &imsg
);
638 fatal("%s: imsg_get", __func__
);
643 log_debug("%s: %s %d got imsg %d peerid %d from %s %d",
644 __func__
, title
, ps
->ps_instance
+ 1,
645 imsg
.hdr
.type
, imsg
.hdr
.peerid
, p
->p_title
, imsg
.hdr
.pid
);
649 * Check the message with the program callback
651 if ((p
->p_cb
)(fd
, p
, &imsg
) == 0) {
652 /* Message was handled by the callback, continue */
658 * Generic message handling
660 switch (imsg
.hdr
.type
) {
661 case IMSG_CTL_VERBOSE
:
662 log_info("%s", __func__
);
663 IMSG_SIZE_CHECK(&imsg
, &verbose
);
664 memcpy(&verbose
, imsg
.data
, sizeof(verbose
));
665 log_setverbose(verbose
);
667 case IMSG_CTL_PROCFD
:
668 IMSG_SIZE_CHECK(&imsg
, &pf
);
669 memcpy(&pf
, imsg
.data
, sizeof(pf
));
670 proc_accept(ps
, imsg
.fd
, pf
.pf_procid
,
674 log_warnx("%s: %s %d got invalid imsg %d peerid %d "
676 __func__
, title
, ps
->ps_instance
+ 1,
677 imsg
.hdr
.type
, imsg
.hdr
.peerid
,
678 p
->p_title
, imsg
.hdr
.pid
);
686 proc_dispatch_null(int fd
, struct privsep_proc
*p
, struct imsg
*imsg
)
692 * imsg helper functions
696 imsg_event_add(struct imsgev
*iev
)
698 if (iev
->handler
== NULL
) {
699 imsg_flush(&iev
->ibuf
);
703 iev
->events
= EV_READ
;
704 if (iev
->ibuf
.w
.queued
)
705 iev
->events
|= EV_WRITE
;
708 event_set(&iev
->ev
, iev
->ibuf
.fd
, iev
->events
, iev
->handler
, iev
->data
);
709 event_add(&iev
->ev
, NULL
);
713 imsg_compose_event(struct imsgev
*iev
, uint16_t type
, uint32_t peerid
,
714 pid_t pid
, int fd
, void *data
, uint16_t datalen
)
718 ret
= imsg_compose(&iev
->ibuf
, type
, peerid
, pid
, fd
, data
, datalen
);
726 imsg_composev_event(struct imsgev
*iev
, uint16_t type
, uint32_t peerid
,
727 pid_t pid
, int fd
, const struct iovec
*iov
, int iovcnt
)
731 ret
= imsg_composev(&iev
->ibuf
, type
, peerid
, pid
, fd
, iov
, iovcnt
);
739 proc_range(struct privsep
*ps
, enum privsep_procid id
, int *n
, int *m
)
742 /* Use a range of all target instances */
744 *m
= ps
->ps_instances
[id
];
746 /* Use only a single slot of the specified peer process */
752 proc_compose_imsg(struct privsep
*ps
, enum privsep_procid id
, int n
,
753 uint16_t type
, uint32_t peerid
, int fd
, void *data
, uint16_t datalen
)
757 proc_range(ps
, id
, &n
, &m
);
759 if (imsg_compose_event(&ps
->ps_ievs
[id
][n
],
760 type
, peerid
, ps
->ps_instance
+ 1, fd
, data
, datalen
) == -1)
768 proc_compose(struct privsep
*ps
, enum privsep_procid id
,
769 uint16_t type
, void *data
, uint16_t datalen
)
771 return (proc_compose_imsg(ps
, id
, -1, type
, -1, -1, data
, datalen
));
775 proc_composev_imsg(struct privsep
*ps
, enum privsep_procid id
, int n
,
776 uint16_t type
, uint32_t peerid
, int fd
, const struct iovec
*iov
, int iovcnt
)
780 proc_range(ps
, id
, &n
, &m
);
782 if (imsg_composev_event(&ps
->ps_ievs
[id
][n
],
783 type
, peerid
, ps
->ps_instance
+ 1, fd
, iov
, iovcnt
) == -1)
790 proc_composev(struct privsep
*ps
, enum privsep_procid id
,
791 uint16_t type
, const struct iovec
*iov
, int iovcnt
)
793 return (proc_composev_imsg(ps
, id
, -1, type
, -1, -1, iov
, iovcnt
));
797 proc_forward_imsg(struct privsep
*ps
, struct imsg
*imsg
,
798 enum privsep_procid id
, int n
)
800 return (proc_compose_imsg(ps
, id
, n
, imsg
->hdr
.type
,
801 imsg
->hdr
.peerid
, imsg
->fd
, imsg
->data
, IMSG_DATA_SIZE(imsg
)));
805 proc_ibuf(struct privsep
*ps
, enum privsep_procid id
, int n
)
809 proc_range(ps
, id
, &n
, &m
);
810 return (&ps
->ps_ievs
[id
][n
].ibuf
);
814 proc_iev(struct privsep
*ps
, enum privsep_procid id
, int n
)
818 proc_range(ps
, id
, &n
, &m
);
819 return (&ps
->ps_ievs
[id
][n
]);
822 /* This function should only be called with care as it breaks async I/O */
824 proc_flush_imsg(struct privsep
*ps
, enum privsep_procid id
, int n
)
826 struct imsgbuf
*ibuf
;
829 proc_range(ps
, id
, &n
, &m
);
831 ibuf
= proc_ibuf(ps
, id
, n
);
835 ret
= imsg_flush(ibuf
);
836 } while (ret
== -1 && errno
== EAGAIN
);
839 imsg_event_add(&ps
->ps_ievs
[id
][n
]);