1 98b6dee9 2022-01-28 op /*	$OpenBSD: imsg.c,v 1.17 2022/01/28 10:41:44 claudio Exp $	*/
  2 b0003f58 2021-03-08 op 
  3 b0003f58 2021-03-08 op /*
  4 b0003f58 2021-03-08 op  * Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
  5 b0003f58 2021-03-08 op  *
  6 b0003f58 2021-03-08 op  * Permission to use, copy, modify, and distribute this software for any
  7 b0003f58 2021-03-08 op  * purpose with or without fee is hereby granted, provided that the above
  8 b0003f58 2021-03-08 op  * copyright notice and this permission notice appear in all copies.
  9 b0003f58 2021-03-08 op  *
 10 b0003f58 2021-03-08 op  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 11 b0003f58 2021-03-08 op  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 12 b0003f58 2021-03-08 op  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 13 b0003f58 2021-03-08 op  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 14 b0003f58 2021-03-08 op  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 15 b0003f58 2021-03-08 op  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 16 b0003f58 2021-03-08 op  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 17 b0003f58 2021-03-08 op  */
 18 a625907c 2021-03-19 op 
 19 a625907c 2021-03-19 op #include "compat.h"
 20 b0003f58 2021-03-08 op 
 21 b0003f58 2021-03-08 op #include <sys/types.h>
 22 b0003f58 2021-03-08 op #include <sys/socket.h>
 23 b0003f58 2021-03-08 op #include <sys/uio.h>
 24 b0003f58 2021-03-08 op 
 25 b0003f58 2021-03-08 op #include <errno.h>
 26 b0003f58 2021-03-08 op #include <stdlib.h>
 27 b0003f58 2021-03-08 op #include <string.h>
 28 b0003f58 2021-03-08 op #include <unistd.h>
 29 b0003f58 2021-03-08 op 
 30 b0003f58 2021-03-08 op #include "imsg.h"
 31 b0003f58 2021-03-08 op 
 32 b0003f58 2021-03-08 op int	 imsg_fd_overhead = 0;
 33 b0003f58 2021-03-08 op 
 34 b0003f58 2021-03-08 op static int	 imsg_get_fd(struct imsgbuf *);
 35 b0003f58 2021-03-08 op 
 36 b0003f58 2021-03-08 op void
 37 b0003f58 2021-03-08 op imsg_init(struct imsgbuf *ibuf, int fd)
 38 b0003f58 2021-03-08 op {
 39 b0003f58 2021-03-08 op 	msgbuf_init(&ibuf->w);
 40 b0003f58 2021-03-08 op 	memset(&ibuf->r, 0, sizeof(ibuf->r));
 41 b0003f58 2021-03-08 op 	ibuf->fd = fd;
 42 b0003f58 2021-03-08 op 	ibuf->w.fd = fd;
 43 b0003f58 2021-03-08 op 	ibuf->pid = getpid();
 44 b0003f58 2021-03-08 op 	TAILQ_INIT(&ibuf->fds);
 45 b0003f58 2021-03-08 op }
 46 b0003f58 2021-03-08 op 
 47 b0003f58 2021-03-08 op ssize_t
 48 b0003f58 2021-03-08 op imsg_read(struct imsgbuf *ibuf)
 49 b0003f58 2021-03-08 op {
 50 b0003f58 2021-03-08 op 	struct msghdr		 msg;
 51 b0003f58 2021-03-08 op 	struct cmsghdr		*cmsg;
 52 b0003f58 2021-03-08 op 	union {
 53 b0003f58 2021-03-08 op 		struct cmsghdr hdr;
 54 b0003f58 2021-03-08 op 		char	buf[CMSG_SPACE(sizeof(int) * 1)];
 55 b0003f58 2021-03-08 op 	} cmsgbuf;
 56 b0003f58 2021-03-08 op 	struct iovec		 iov;
 57 b0003f58 2021-03-08 op 	ssize_t			 n = -1;
 58 b0003f58 2021-03-08 op 	int			 fd;
 59 b0003f58 2021-03-08 op 	struct imsg_fd		*ifd;
 60 b0003f58 2021-03-08 op 
 61 b0003f58 2021-03-08 op 	memset(&msg, 0, sizeof(msg));
 62 b0003f58 2021-03-08 op 	memset(&cmsgbuf, 0, sizeof(cmsgbuf));
 63 b0003f58 2021-03-08 op 
 64 b0003f58 2021-03-08 op 	iov.iov_base = ibuf->r.buf + ibuf->r.wpos;
 65 b0003f58 2021-03-08 op 	iov.iov_len = sizeof(ibuf->r.buf) - ibuf->r.wpos;
 66 b0003f58 2021-03-08 op 	msg.msg_iov = &iov;
 67 b0003f58 2021-03-08 op 	msg.msg_iovlen = 1;
 68 b0003f58 2021-03-08 op 	msg.msg_control = &cmsgbuf.buf;
 69 b0003f58 2021-03-08 op 	msg.msg_controllen = sizeof(cmsgbuf.buf);
 70 b0003f58 2021-03-08 op 
 71 b0003f58 2021-03-08 op 	if ((ifd = calloc(1, sizeof(struct imsg_fd))) == NULL)
 72 b0003f58 2021-03-08 op 		return (-1);
 73 b0003f58 2021-03-08 op 
 74 b0003f58 2021-03-08 op again:
 75 b0003f58 2021-03-08 op 	if (getdtablecount() + imsg_fd_overhead +
 76 b0003f58 2021-03-08 op 	    (int)((CMSG_SPACE(sizeof(int))-CMSG_SPACE(0))/sizeof(int))
 77 b0003f58 2021-03-08 op 	    >= getdtablesize()) {
 78 b0003f58 2021-03-08 op 		errno = EAGAIN;
 79 b0003f58 2021-03-08 op 		free(ifd);
 80 b0003f58 2021-03-08 op 		return (-1);
 81 b0003f58 2021-03-08 op 	}
 82 b0003f58 2021-03-08 op 
 83 b0003f58 2021-03-08 op 	if ((n = recvmsg(ibuf->fd, &msg, 0)) == -1) {
 84 b0003f58 2021-03-08 op 		if (errno == EINTR)
 85 b0003f58 2021-03-08 op 			goto again;
 86 b0003f58 2021-03-08 op 		goto fail;
 87 b0003f58 2021-03-08 op 	}
 88 b0003f58 2021-03-08 op 
 89 b0003f58 2021-03-08 op 	ibuf->r.wpos += n;
 90 b0003f58 2021-03-08 op 
 91 b0003f58 2021-03-08 op 	for (cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL;
 92 b0003f58 2021-03-08 op 	    cmsg = CMSG_NXTHDR(&msg, cmsg)) {
 93 b0003f58 2021-03-08 op 		if (cmsg->cmsg_level == SOL_SOCKET &&
 94 b0003f58 2021-03-08 op 		    cmsg->cmsg_type == SCM_RIGHTS) {
 95 b0003f58 2021-03-08 op 			int i;
 96 b0003f58 2021-03-08 op 			int j;
 97 b0003f58 2021-03-08 op 
 98 b0003f58 2021-03-08 op 			/*
 99 b0003f58 2021-03-08 op 			 * We only accept one file descriptor.  Due to C
100 b0003f58 2021-03-08 op 			 * padding rules, our control buffer might contain
101 b0003f58 2021-03-08 op 			 * more than one fd, and we must close them.
102 b0003f58 2021-03-08 op 			 */
103 b0003f58 2021-03-08 op 			j = ((char *)cmsg + cmsg->cmsg_len -
104 b0003f58 2021-03-08 op 			    (char *)CMSG_DATA(cmsg)) / sizeof(int);
105 b0003f58 2021-03-08 op 			for (i = 0; i < j; i++) {
106 b0003f58 2021-03-08 op 				fd = ((int *)CMSG_DATA(cmsg))[i];
107 b0003f58 2021-03-08 op 				if (ifd != NULL) {
108 b0003f58 2021-03-08 op 					ifd->fd = fd;
109 b0003f58 2021-03-08 op 					TAILQ_INSERT_TAIL(&ibuf->fds, ifd,
110 b0003f58 2021-03-08 op 					    entry);
111 b0003f58 2021-03-08 op 					ifd = NULL;
112 b0003f58 2021-03-08 op 				} else
113 b0003f58 2021-03-08 op 					close(fd);
114 b0003f58 2021-03-08 op 			}
115 b0003f58 2021-03-08 op 		}
116 b0003f58 2021-03-08 op 		/* we do not handle other ctl data level */
117 b0003f58 2021-03-08 op 	}
118 b0003f58 2021-03-08 op 
119 b0003f58 2021-03-08 op fail:
120 b0003f58 2021-03-08 op 	free(ifd);
121 b0003f58 2021-03-08 op 	return (n);
122 b0003f58 2021-03-08 op }
123 b0003f58 2021-03-08 op 
124 b0003f58 2021-03-08 op ssize_t
125 b0003f58 2021-03-08 op imsg_get(struct imsgbuf *ibuf, struct imsg *imsg)
126 b0003f58 2021-03-08 op {
127 b0003f58 2021-03-08 op 	size_t			 av, left, datalen;
128 b0003f58 2021-03-08 op 
129 b0003f58 2021-03-08 op 	av = ibuf->r.wpos;
130 b0003f58 2021-03-08 op 
131 b0003f58 2021-03-08 op 	if (IMSG_HEADER_SIZE > av)
132 b0003f58 2021-03-08 op 		return (0);
133 b0003f58 2021-03-08 op 
134 b0003f58 2021-03-08 op 	memcpy(&imsg->hdr, ibuf->r.buf, sizeof(imsg->hdr));
135 b0003f58 2021-03-08 op 	if (imsg->hdr.len < IMSG_HEADER_SIZE ||
136 b0003f58 2021-03-08 op 	    imsg->hdr.len > MAX_IMSGSIZE) {
137 b0003f58 2021-03-08 op 		errno = ERANGE;
138 b0003f58 2021-03-08 op 		return (-1);
139 b0003f58 2021-03-08 op 	}
140 b0003f58 2021-03-08 op 	if (imsg->hdr.len > av)
141 b0003f58 2021-03-08 op 		return (0);
142 b0003f58 2021-03-08 op 	datalen = imsg->hdr.len - IMSG_HEADER_SIZE;
143 b0003f58 2021-03-08 op 	ibuf->r.rptr = ibuf->r.buf + IMSG_HEADER_SIZE;
144 b0003f58 2021-03-08 op 	if (datalen == 0)
145 b0003f58 2021-03-08 op 		imsg->data = NULL;
146 b0003f58 2021-03-08 op 	else if ((imsg->data = malloc(datalen)) == NULL)
147 b0003f58 2021-03-08 op 		return (-1);
148 b0003f58 2021-03-08 op 
149 b0003f58 2021-03-08 op 	if (imsg->hdr.flags & IMSGF_HASFD)
150 b0003f58 2021-03-08 op 		imsg->fd = imsg_get_fd(ibuf);
151 b0003f58 2021-03-08 op 	else
152 b0003f58 2021-03-08 op 		imsg->fd = -1;
153 b0003f58 2021-03-08 op 
154 98b6dee9 2022-01-28 op 	if (datalen != 0)
155 98b6dee9 2022-01-28 op 		memcpy(imsg->data, ibuf->r.rptr, datalen);
156 b0003f58 2021-03-08 op 
157 b0003f58 2021-03-08 op 	if (imsg->hdr.len < av) {
158 b0003f58 2021-03-08 op 		left = av - imsg->hdr.len;
159 b0003f58 2021-03-08 op 		memmove(&ibuf->r.buf, ibuf->r.buf + imsg->hdr.len, left);
160 b0003f58 2021-03-08 op 		ibuf->r.wpos = left;
161 b0003f58 2021-03-08 op 	} else
162 b0003f58 2021-03-08 op 		ibuf->r.wpos = 0;
163 b0003f58 2021-03-08 op 
164 b0003f58 2021-03-08 op 	return (datalen + IMSG_HEADER_SIZE);
165 b0003f58 2021-03-08 op }
166 b0003f58 2021-03-08 op 
167 b0003f58 2021-03-08 op int
168 b0003f58 2021-03-08 op imsg_compose(struct imsgbuf *ibuf, uint32_t type, uint32_t peerid, pid_t pid,
169 b0003f58 2021-03-08 op     int fd, const void *data, uint16_t datalen)
170 b0003f58 2021-03-08 op {
171 b0003f58 2021-03-08 op 	struct ibuf	*wbuf;
172 b0003f58 2021-03-08 op 
173 b0003f58 2021-03-08 op 	if ((wbuf = imsg_create(ibuf, type, peerid, pid, datalen)) == NULL)
174 b0003f58 2021-03-08 op 		return (-1);
175 b0003f58 2021-03-08 op 
176 b0003f58 2021-03-08 op 	if (imsg_add(wbuf, data, datalen) == -1)
177 b0003f58 2021-03-08 op 		return (-1);
178 b0003f58 2021-03-08 op 
179 b0003f58 2021-03-08 op 	wbuf->fd = fd;
180 b0003f58 2021-03-08 op 
181 b0003f58 2021-03-08 op 	imsg_close(ibuf, wbuf);
182 b0003f58 2021-03-08 op 
183 b0003f58 2021-03-08 op 	return (1);
184 b0003f58 2021-03-08 op }
185 b0003f58 2021-03-08 op 
186 b0003f58 2021-03-08 op int
187 b0003f58 2021-03-08 op imsg_composev(struct imsgbuf *ibuf, uint32_t type, uint32_t peerid, pid_t pid,
188 b0003f58 2021-03-08 op     int fd, const struct iovec *iov, int iovcnt)
189 b0003f58 2021-03-08 op {
190 b0003f58 2021-03-08 op 	struct ibuf	*wbuf;
191 b0003f58 2021-03-08 op 	int		 i, datalen = 0;
192 b0003f58 2021-03-08 op 
193 b0003f58 2021-03-08 op 	for (i = 0; i < iovcnt; i++)
194 b0003f58 2021-03-08 op 		datalen += iov[i].iov_len;
195 b0003f58 2021-03-08 op 
196 b0003f58 2021-03-08 op 	if ((wbuf = imsg_create(ibuf, type, peerid, pid, datalen)) == NULL)
197 b0003f58 2021-03-08 op 		return (-1);
198 b0003f58 2021-03-08 op 
199 b0003f58 2021-03-08 op 	for (i = 0; i < iovcnt; i++)
200 b0003f58 2021-03-08 op 		if (imsg_add(wbuf, iov[i].iov_base, iov[i].iov_len) == -1)
201 b0003f58 2021-03-08 op 			return (-1);
202 b0003f58 2021-03-08 op 
203 b0003f58 2021-03-08 op 	wbuf->fd = fd;
204 b0003f58 2021-03-08 op 
205 b0003f58 2021-03-08 op 	imsg_close(ibuf, wbuf);
206 b0003f58 2021-03-08 op 
207 b0003f58 2021-03-08 op 	return (1);
208 b0003f58 2021-03-08 op }
209 b0003f58 2021-03-08 op 
210 b0003f58 2021-03-08 op /* ARGSUSED */
211 b0003f58 2021-03-08 op struct ibuf *
212 b0003f58 2021-03-08 op imsg_create(struct imsgbuf *ibuf, uint32_t type, uint32_t peerid, pid_t pid,
213 b0003f58 2021-03-08 op     uint16_t datalen)
214 b0003f58 2021-03-08 op {
215 b0003f58 2021-03-08 op 	struct ibuf	*wbuf;
216 b0003f58 2021-03-08 op 	struct imsg_hdr	 hdr;
217 b0003f58 2021-03-08 op 
218 b0003f58 2021-03-08 op 	datalen += IMSG_HEADER_SIZE;
219 b0003f58 2021-03-08 op 	if (datalen > MAX_IMSGSIZE) {
220 b0003f58 2021-03-08 op 		errno = ERANGE;
221 b0003f58 2021-03-08 op 		return (NULL);
222 b0003f58 2021-03-08 op 	}
223 b0003f58 2021-03-08 op 
224 b0003f58 2021-03-08 op 	hdr.type = type;
225 b0003f58 2021-03-08 op 	hdr.flags = 0;
226 b0003f58 2021-03-08 op 	hdr.peerid = peerid;
227 b0003f58 2021-03-08 op 	if ((hdr.pid = pid) == 0)
228 b0003f58 2021-03-08 op 		hdr.pid = ibuf->pid;
229 b0003f58 2021-03-08 op 	if ((wbuf = ibuf_dynamic(datalen, MAX_IMSGSIZE)) == NULL) {
230 b0003f58 2021-03-08 op 		return (NULL);
231 b0003f58 2021-03-08 op 	}
232 b0003f58 2021-03-08 op 	if (imsg_add(wbuf, &hdr, sizeof(hdr)) == -1)
233 b0003f58 2021-03-08 op 		return (NULL);
234 b0003f58 2021-03-08 op 
235 b0003f58 2021-03-08 op 	return (wbuf);
236 b0003f58 2021-03-08 op }
237 b0003f58 2021-03-08 op 
238 b0003f58 2021-03-08 op int
239 b0003f58 2021-03-08 op imsg_add(struct ibuf *msg, const void *data, uint16_t datalen)
240 b0003f58 2021-03-08 op {
241 b0003f58 2021-03-08 op 	if (datalen)
242 b0003f58 2021-03-08 op 		if (ibuf_add(msg, data, datalen) == -1) {
243 b0003f58 2021-03-08 op 			ibuf_free(msg);
244 b0003f58 2021-03-08 op 			return (-1);
245 b0003f58 2021-03-08 op 		}
246 b0003f58 2021-03-08 op 	return (datalen);
247 b0003f58 2021-03-08 op }
248 b0003f58 2021-03-08 op 
249 b0003f58 2021-03-08 op void
250 b0003f58 2021-03-08 op imsg_close(struct imsgbuf *ibuf, struct ibuf *msg)
251 b0003f58 2021-03-08 op {
252 b0003f58 2021-03-08 op 	struct imsg_hdr	*hdr;
253 b0003f58 2021-03-08 op 
254 b0003f58 2021-03-08 op 	hdr = (struct imsg_hdr *)msg->buf;
255 b0003f58 2021-03-08 op 
256 b0003f58 2021-03-08 op 	hdr->flags &= ~IMSGF_HASFD;
257 b0003f58 2021-03-08 op 	if (msg->fd != -1)
258 b0003f58 2021-03-08 op 		hdr->flags |= IMSGF_HASFD;
259 b0003f58 2021-03-08 op 
260 b0003f58 2021-03-08 op 	hdr->len = (uint16_t)msg->wpos;
261 b0003f58 2021-03-08 op 
262 b0003f58 2021-03-08 op 	ibuf_close(&ibuf->w, msg);
263 b0003f58 2021-03-08 op }
264 b0003f58 2021-03-08 op 
265 b0003f58 2021-03-08 op void
266 b0003f58 2021-03-08 op imsg_free(struct imsg *imsg)
267 b0003f58 2021-03-08 op {
268 b0003f58 2021-03-08 op 	freezero(imsg->data, imsg->hdr.len - IMSG_HEADER_SIZE);
269 b0003f58 2021-03-08 op }
270 b0003f58 2021-03-08 op 
271 b0003f58 2021-03-08 op static int
272 b0003f58 2021-03-08 op imsg_get_fd(struct imsgbuf *ibuf)
273 b0003f58 2021-03-08 op {
274 b0003f58 2021-03-08 op 	int		 fd;
275 b0003f58 2021-03-08 op 	struct imsg_fd	*ifd;
276 b0003f58 2021-03-08 op 
277 b0003f58 2021-03-08 op 	if ((ifd = TAILQ_FIRST(&ibuf->fds)) == NULL)
278 b0003f58 2021-03-08 op 		return (-1);
279 b0003f58 2021-03-08 op 
280 b0003f58 2021-03-08 op 	fd = ifd->fd;
281 b0003f58 2021-03-08 op 	TAILQ_REMOVE(&ibuf->fds, ifd, entry);
282 b0003f58 2021-03-08 op 	free(ifd);
283 b0003f58 2021-03-08 op 
284 b0003f58 2021-03-08 op 	return (fd);
285 b0003f58 2021-03-08 op }
286 b0003f58 2021-03-08 op 
287 b0003f58 2021-03-08 op int
288 b0003f58 2021-03-08 op imsg_flush(struct imsgbuf *ibuf)
289 b0003f58 2021-03-08 op {
290 b0003f58 2021-03-08 op 	while (ibuf->w.queued)
291 b0003f58 2021-03-08 op 		if (msgbuf_write(&ibuf->w) <= 0)
292 b0003f58 2021-03-08 op 			return (-1);
293 b0003f58 2021-03-08 op 	return (0);
294 b0003f58 2021-03-08 op }
295 b0003f58 2021-03-08 op 
296 b0003f58 2021-03-08 op void
297 b0003f58 2021-03-08 op imsg_clear(struct imsgbuf *ibuf)
298 b0003f58 2021-03-08 op {
299 b0003f58 2021-03-08 op 	int	fd;
300 b0003f58 2021-03-08 op 
301 b0003f58 2021-03-08 op 	msgbuf_clear(&ibuf->w);
302 b0003f58 2021-03-08 op 	while ((fd = imsg_get_fd(ibuf)) != -1)
303 b0003f58 2021-03-08 op 		close(fd);
304 b0003f58 2021-03-08 op }