2 * Copyright (c) 2015 Nuxi, https://nuxi.nl/
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/param.h>
30 #include <sys/capsicum.h>
31 #include <sys/filedesc.h>
34 #include <sys/socketvar.h>
35 #include <sys/syscallsubr.h>
36 #include <sys/sysproto.h>
37 #include <sys/systm.h>
38 #include <sys/unistd.h>
39 #include <sys/vnode.h>
41 #include <contrib/cloudabi/cloudabi_types_common.h>
43 #include <compat/cloudabi/cloudabi_proto.h>
44 #include <compat/cloudabi/cloudabi_util.h>
46 /* Translation between CloudABI and Capsicum rights. */
47 #define RIGHTS_MAPPINGS \
48 MAPPING(CLOUDABI_RIGHT_FD_DATASYNC, CAP_FSYNC) \
49 MAPPING(CLOUDABI_RIGHT_FD_READ, CAP_READ) \
50 MAPPING(CLOUDABI_RIGHT_FD_SEEK, CAP_SEEK) \
51 MAPPING(CLOUDABI_RIGHT_FD_STAT_PUT_FLAGS, CAP_FCNTL) \
52 MAPPING(CLOUDABI_RIGHT_FD_SYNC, CAP_FSYNC) \
53 MAPPING(CLOUDABI_RIGHT_FD_TELL, CAP_SEEK_TELL) \
54 MAPPING(CLOUDABI_RIGHT_FD_WRITE, CAP_WRITE) \
55 MAPPING(CLOUDABI_RIGHT_FILE_ADVISE) \
56 MAPPING(CLOUDABI_RIGHT_FILE_ALLOCATE, CAP_WRITE) \
57 MAPPING(CLOUDABI_RIGHT_FILE_CREATE_DIRECTORY, CAP_MKDIRAT) \
58 MAPPING(CLOUDABI_RIGHT_FILE_CREATE_FILE, CAP_CREATE) \
59 MAPPING(CLOUDABI_RIGHT_FILE_CREATE_FIFO, CAP_MKFIFOAT) \
60 MAPPING(CLOUDABI_RIGHT_FILE_LINK_SOURCE, CAP_LINKAT_SOURCE) \
61 MAPPING(CLOUDABI_RIGHT_FILE_LINK_TARGET, CAP_LINKAT_TARGET) \
62 MAPPING(CLOUDABI_RIGHT_FILE_OPEN, CAP_LOOKUP) \
63 MAPPING(CLOUDABI_RIGHT_FILE_READDIR, CAP_READ) \
64 MAPPING(CLOUDABI_RIGHT_FILE_READLINK, CAP_LOOKUP) \
65 MAPPING(CLOUDABI_RIGHT_FILE_RENAME_SOURCE, CAP_RENAMEAT_SOURCE) \
66 MAPPING(CLOUDABI_RIGHT_FILE_RENAME_TARGET, CAP_RENAMEAT_TARGET) \
67 MAPPING(CLOUDABI_RIGHT_FILE_STAT_FGET, CAP_FSTAT) \
68 MAPPING(CLOUDABI_RIGHT_FILE_STAT_FPUT_SIZE, CAP_FTRUNCATE) \
69 MAPPING(CLOUDABI_RIGHT_FILE_STAT_FPUT_TIMES, CAP_FUTIMES) \
70 MAPPING(CLOUDABI_RIGHT_FILE_STAT_GET, CAP_FSTATAT) \
71 MAPPING(CLOUDABI_RIGHT_FILE_STAT_PUT_TIMES, CAP_FUTIMESAT) \
72 MAPPING(CLOUDABI_RIGHT_FILE_SYMLINK, CAP_SYMLINKAT) \
73 MAPPING(CLOUDABI_RIGHT_FILE_UNLINK, CAP_UNLINKAT) \
74 MAPPING(CLOUDABI_RIGHT_MEM_MAP, CAP_MMAP) \
75 MAPPING(CLOUDABI_RIGHT_MEM_MAP_EXEC, CAP_MMAP_X) \
76 MAPPING(CLOUDABI_RIGHT_POLL_FD_READWRITE, CAP_EVENT) \
77 MAPPING(CLOUDABI_RIGHT_POLL_MODIFY, CAP_KQUEUE_CHANGE) \
78 MAPPING(CLOUDABI_RIGHT_POLL_PROC_TERMINATE, CAP_EVENT) \
79 MAPPING(CLOUDABI_RIGHT_POLL_WAIT, CAP_KQUEUE_EVENT) \
80 MAPPING(CLOUDABI_RIGHT_PROC_EXEC, CAP_FEXECVE) \
81 MAPPING(CLOUDABI_RIGHT_SOCK_ACCEPT, CAP_ACCEPT) \
82 MAPPING(CLOUDABI_RIGHT_SOCK_BIND_DIRECTORY, CAP_BINDAT) \
83 MAPPING(CLOUDABI_RIGHT_SOCK_BIND_SOCKET, CAP_BIND) \
84 MAPPING(CLOUDABI_RIGHT_SOCK_CONNECT_DIRECTORY, CAP_CONNECTAT) \
85 MAPPING(CLOUDABI_RIGHT_SOCK_CONNECT_SOCKET, CAP_CONNECT) \
86 MAPPING(CLOUDABI_RIGHT_SOCK_LISTEN, CAP_LISTEN) \
87 MAPPING(CLOUDABI_RIGHT_SOCK_SHUTDOWN, CAP_SHUTDOWN) \
88 MAPPING(CLOUDABI_RIGHT_SOCK_STAT_GET, CAP_GETPEERNAME, \
89 CAP_GETSOCKNAME, CAP_GETSOCKOPT)
92 cloudabi_sys_fd_close(struct thread *td, struct cloudabi_sys_fd_close_args *uap)
95 return (kern_close(td, uap->fd));
99 cloudabi_sys_fd_create1(struct thread *td,
100 struct cloudabi_sys_fd_create1_args *uap)
102 struct filecaps fcaps = {};
105 case CLOUDABI_FILETYPE_POLL:
106 cap_rights_init(&fcaps.fc_rights, CAP_FSTAT, CAP_KQUEUE);
107 return (kern_kqueue(td, 0, &fcaps));
108 case CLOUDABI_FILETYPE_SHARED_MEMORY:
109 cap_rights_init(&fcaps.fc_rights, CAP_FSTAT, CAP_FTRUNCATE,
111 return (kern_shm_open(td, SHM_ANON, O_RDWR, 0, &fcaps));
112 case CLOUDABI_FILETYPE_SOCKET_DGRAM:
113 return (kern_socket(td, AF_UNIX, SOCK_DGRAM, 0));
114 case CLOUDABI_FILETYPE_SOCKET_STREAM:
115 return (kern_socket(td, AF_UNIX, SOCK_STREAM, 0));
122 cloudabi_sys_fd_create2(struct thread *td,
123 struct cloudabi_sys_fd_create2_args *uap)
125 struct filecaps fcaps1 = {}, fcaps2 = {};
130 case CLOUDABI_FILETYPE_FIFO:
132 * CloudABI pipes are unidirectional. Restrict rights on
133 * the pipe to simulate this.
135 cap_rights_init(&fcaps1.fc_rights, CAP_EVENT, CAP_FCNTL,
136 CAP_FSTAT, CAP_READ);
137 fcaps1.fc_fcntls = CAP_FCNTL_SETFL;
138 cap_rights_init(&fcaps2.fc_rights, CAP_EVENT, CAP_FCNTL,
139 CAP_FSTAT, CAP_WRITE);
140 fcaps2.fc_fcntls = CAP_FCNTL_SETFL;
141 error = kern_pipe(td, fds, 0, &fcaps1, &fcaps2);
143 case CLOUDABI_FILETYPE_SOCKET_DGRAM:
144 error = kern_socketpair(td, AF_UNIX, SOCK_DGRAM, 0, fds);
146 case CLOUDABI_FILETYPE_SOCKET_STREAM:
147 error = kern_socketpair(td, AF_UNIX, SOCK_STREAM, 0, fds);
154 td->td_retval[0] = fds[0];
155 td->td_retval[1] = fds[1];
161 cloudabi_sys_fd_datasync(struct thread *td,
162 struct cloudabi_sys_fd_datasync_args *uap)
165 return (kern_fsync(td, uap->fd, false));
169 cloudabi_sys_fd_dup(struct thread *td, struct cloudabi_sys_fd_dup_args *uap)
172 return (kern_dup(td, FDDUP_NORMAL, 0, uap->from, 0));
176 cloudabi_sys_fd_replace(struct thread *td,
177 struct cloudabi_sys_fd_replace_args *uap)
182 * CloudABI's equivalent to dup2(). CloudABI processes should
183 * not depend on hardcoded file descriptor layouts, but simply
184 * use the file descriptor numbers that are allocated by the
185 * kernel. Duplicating file descriptors to arbitrary numbers
186 * should not be done.
188 * Invoke kern_dup() with FDDUP_MUSTREPLACE, so that we return
189 * EBADF when duplicating to a nonexistent file descriptor. Also
190 * clear the return value, as this system call yields no return
193 error = kern_dup(td, FDDUP_MUSTREPLACE, 0, uap->from, uap->to);
194 td->td_retval[0] = 0;
199 cloudabi_sys_fd_seek(struct thread *td, struct cloudabi_sys_fd_seek_args *uap)
203 switch (uap->whence) {
204 case CLOUDABI_WHENCE_CUR:
207 case CLOUDABI_WHENCE_END:
210 case CLOUDABI_WHENCE_SET:
217 return (kern_lseek(td, uap->fd, uap->offset, whence));
220 /* Converts a file descriptor to a CloudABI file descriptor type. */
222 cloudabi_convert_filetype(const struct file *fp)
227 switch (fp->f_type) {
229 return (CLOUDABI_FILETYPE_FIFO);
231 return (CLOUDABI_FILETYPE_POLL);
233 return (CLOUDABI_FILETYPE_FIFO);
235 return (CLOUDABI_FILETYPE_PROCESS);
237 return (CLOUDABI_FILETYPE_SHARED_MEMORY);
240 switch (so->so_type) {
242 return (CLOUDABI_FILETYPE_SOCKET_DGRAM);
244 return (CLOUDABI_FILETYPE_SOCKET_STREAM);
246 return (CLOUDABI_FILETYPE_UNKNOWN);
250 switch (vp->v_type) {
252 return (CLOUDABI_FILETYPE_BLOCK_DEVICE);
254 return (CLOUDABI_FILETYPE_CHARACTER_DEVICE);
256 return (CLOUDABI_FILETYPE_DIRECTORY);
258 return (CLOUDABI_FILETYPE_FIFO);
260 return (CLOUDABI_FILETYPE_SYMBOLIC_LINK);
262 return (CLOUDABI_FILETYPE_REGULAR_FILE);
264 return (CLOUDABI_FILETYPE_SOCKET_STREAM);
266 return (CLOUDABI_FILETYPE_UNKNOWN);
269 return (CLOUDABI_FILETYPE_UNKNOWN);
273 /* Removes rights that conflict with the file descriptor type. */
275 cloudabi_remove_conflicting_rights(cloudabi_filetype_t filetype,
276 cloudabi_rights_t *base, cloudabi_rights_t *inheriting)
280 * CloudABI has a small number of additional rights bits to
281 * disambiguate between multiple purposes. Remove the bits that
282 * don't apply to the type of the file descriptor.
284 * As file descriptor access modes (O_ACCMODE) has been fully
285 * replaced by rights bits, CloudABI distinguishes between
286 * rights that apply to the file descriptor itself (base) versus
287 * rights of new file descriptors derived from them
288 * (inheriting). The code below approximates the pair by
289 * decomposing depending on the file descriptor type.
291 * We need to be somewhat accurate about which actions can
292 * actually be performed on the file descriptor, as functions
293 * like fcntl(fd, F_GETFL) are emulated on top of this.
296 case CLOUDABI_FILETYPE_DIRECTORY:
297 *base &= CLOUDABI_RIGHT_FD_STAT_PUT_FLAGS |
298 CLOUDABI_RIGHT_FD_SYNC | CLOUDABI_RIGHT_FILE_ADVISE |
299 CLOUDABI_RIGHT_FILE_CREATE_DIRECTORY |
300 CLOUDABI_RIGHT_FILE_CREATE_FILE |
301 CLOUDABI_RIGHT_FILE_CREATE_FIFO |
302 CLOUDABI_RIGHT_FILE_LINK_SOURCE |
303 CLOUDABI_RIGHT_FILE_LINK_TARGET |
304 CLOUDABI_RIGHT_FILE_OPEN |
305 CLOUDABI_RIGHT_FILE_READDIR |
306 CLOUDABI_RIGHT_FILE_READLINK |
307 CLOUDABI_RIGHT_FILE_RENAME_SOURCE |
308 CLOUDABI_RIGHT_FILE_RENAME_TARGET |
309 CLOUDABI_RIGHT_FILE_STAT_FGET |
310 CLOUDABI_RIGHT_FILE_STAT_FPUT_TIMES |
311 CLOUDABI_RIGHT_FILE_STAT_GET |
312 CLOUDABI_RIGHT_FILE_STAT_PUT_TIMES |
313 CLOUDABI_RIGHT_FILE_SYMLINK |
314 CLOUDABI_RIGHT_FILE_UNLINK |
315 CLOUDABI_RIGHT_POLL_FD_READWRITE |
316 CLOUDABI_RIGHT_SOCK_BIND_DIRECTORY |
317 CLOUDABI_RIGHT_SOCK_CONNECT_DIRECTORY;
318 *inheriting &= CLOUDABI_RIGHT_FD_DATASYNC |
319 CLOUDABI_RIGHT_FD_READ |
320 CLOUDABI_RIGHT_FD_SEEK |
321 CLOUDABI_RIGHT_FD_STAT_PUT_FLAGS |
322 CLOUDABI_RIGHT_FD_SYNC |
323 CLOUDABI_RIGHT_FD_TELL |
324 CLOUDABI_RIGHT_FD_WRITE |
325 CLOUDABI_RIGHT_FILE_ADVISE |
326 CLOUDABI_RIGHT_FILE_ALLOCATE |
327 CLOUDABI_RIGHT_FILE_CREATE_DIRECTORY |
328 CLOUDABI_RIGHT_FILE_CREATE_FILE |
329 CLOUDABI_RIGHT_FILE_CREATE_FIFO |
330 CLOUDABI_RIGHT_FILE_LINK_SOURCE |
331 CLOUDABI_RIGHT_FILE_LINK_TARGET |
332 CLOUDABI_RIGHT_FILE_OPEN |
333 CLOUDABI_RIGHT_FILE_READDIR |
334 CLOUDABI_RIGHT_FILE_READLINK |
335 CLOUDABI_RIGHT_FILE_RENAME_SOURCE |
336 CLOUDABI_RIGHT_FILE_RENAME_TARGET |
337 CLOUDABI_RIGHT_FILE_STAT_FGET |
338 CLOUDABI_RIGHT_FILE_STAT_FPUT_SIZE |
339 CLOUDABI_RIGHT_FILE_STAT_FPUT_TIMES |
340 CLOUDABI_RIGHT_FILE_STAT_GET |
341 CLOUDABI_RIGHT_FILE_STAT_PUT_TIMES |
342 CLOUDABI_RIGHT_FILE_SYMLINK |
343 CLOUDABI_RIGHT_FILE_UNLINK |
344 CLOUDABI_RIGHT_MEM_MAP |
345 CLOUDABI_RIGHT_MEM_MAP_EXEC |
346 CLOUDABI_RIGHT_POLL_FD_READWRITE |
347 CLOUDABI_RIGHT_PROC_EXEC |
348 CLOUDABI_RIGHT_SOCK_BIND_DIRECTORY |
349 CLOUDABI_RIGHT_SOCK_CONNECT_DIRECTORY;
351 case CLOUDABI_FILETYPE_FIFO:
352 *base &= CLOUDABI_RIGHT_FD_READ |
353 CLOUDABI_RIGHT_FD_STAT_PUT_FLAGS |
354 CLOUDABI_RIGHT_FD_WRITE |
355 CLOUDABI_RIGHT_FILE_STAT_FGET |
356 CLOUDABI_RIGHT_POLL_FD_READWRITE;
359 case CLOUDABI_FILETYPE_POLL:
360 *base &= ~CLOUDABI_RIGHT_FILE_ADVISE;
363 case CLOUDABI_FILETYPE_PROCESS:
364 *base &= ~(CLOUDABI_RIGHT_FILE_ADVISE |
365 CLOUDABI_RIGHT_POLL_FD_READWRITE);
368 case CLOUDABI_FILETYPE_REGULAR_FILE:
369 *base &= CLOUDABI_RIGHT_FD_DATASYNC |
370 CLOUDABI_RIGHT_FD_READ |
371 CLOUDABI_RIGHT_FD_SEEK |
372 CLOUDABI_RIGHT_FD_STAT_PUT_FLAGS |
373 CLOUDABI_RIGHT_FD_SYNC |
374 CLOUDABI_RIGHT_FD_TELL |
375 CLOUDABI_RIGHT_FD_WRITE |
376 CLOUDABI_RIGHT_FILE_ADVISE |
377 CLOUDABI_RIGHT_FILE_ALLOCATE |
378 CLOUDABI_RIGHT_FILE_STAT_FGET |
379 CLOUDABI_RIGHT_FILE_STAT_FPUT_SIZE |
380 CLOUDABI_RIGHT_FILE_STAT_FPUT_TIMES |
381 CLOUDABI_RIGHT_MEM_MAP |
382 CLOUDABI_RIGHT_MEM_MAP_EXEC |
383 CLOUDABI_RIGHT_POLL_FD_READWRITE |
384 CLOUDABI_RIGHT_PROC_EXEC;
387 case CLOUDABI_FILETYPE_SHARED_MEMORY:
388 *base &= ~(CLOUDABI_RIGHT_FD_SEEK |
389 CLOUDABI_RIGHT_FD_TELL |
390 CLOUDABI_RIGHT_FILE_ADVISE |
391 CLOUDABI_RIGHT_FILE_ALLOCATE |
392 CLOUDABI_RIGHT_FILE_READDIR);
395 case CLOUDABI_FILETYPE_SOCKET_DGRAM:
396 case CLOUDABI_FILETYPE_SOCKET_STREAM:
397 *base &= CLOUDABI_RIGHT_FD_READ |
398 CLOUDABI_RIGHT_FD_STAT_PUT_FLAGS |
399 CLOUDABI_RIGHT_FD_WRITE |
400 CLOUDABI_RIGHT_FILE_STAT_FGET |
401 CLOUDABI_RIGHT_POLL_FD_READWRITE |
402 CLOUDABI_RIGHT_SOCK_ACCEPT |
403 CLOUDABI_RIGHT_SOCK_BIND_SOCKET |
404 CLOUDABI_RIGHT_SOCK_CONNECT_SOCKET |
405 CLOUDABI_RIGHT_SOCK_LISTEN |
406 CLOUDABI_RIGHT_SOCK_SHUTDOWN |
407 CLOUDABI_RIGHT_SOCK_STAT_GET;
415 /* Converts FreeBSD's Capsicum rights to CloudABI's set of rights. */
417 convert_capabilities(const cap_rights_t *capabilities,
418 cloudabi_filetype_t filetype, cloudabi_rights_t *base,
419 cloudabi_rights_t *inheriting)
421 cloudabi_rights_t rights;
423 /* Convert FreeBSD bits to CloudABI bits. */
425 #define MAPPING(cloudabi, ...) do { \
426 if (cap_rights_is_set(capabilities, ##__VA_ARGS__)) \
427 rights |= (cloudabi); \
433 *inheriting = rights;
434 cloudabi_remove_conflicting_rights(filetype, base, inheriting);
438 cloudabi_sys_fd_stat_get(struct thread *td,
439 struct cloudabi_sys_fd_stat_get_args *uap)
441 cloudabi_fdstat_t fsb = {};
444 struct filecaps fcaps;
447 /* Obtain file descriptor properties. */
448 error = fget_cap(td, uap->fd, cap_rights_init(&rights), &fp,
452 oflags = OFLAGS(fp->f_flag);
453 fsb.fs_filetype = cloudabi_convert_filetype(fp);
456 /* Convert file descriptor flags. */
457 if (oflags & O_APPEND)
458 fsb.fs_flags |= CLOUDABI_FDFLAG_APPEND;
459 if (oflags & O_NONBLOCK)
460 fsb.fs_flags |= CLOUDABI_FDFLAG_NONBLOCK;
462 fsb.fs_flags |= CLOUDABI_FDFLAG_SYNC;
464 /* Convert capabilities to CloudABI rights. */
465 convert_capabilities(&fcaps.fc_rights, fsb.fs_filetype,
466 &fsb.fs_rights_base, &fsb.fs_rights_inheriting);
467 filecaps_free(&fcaps);
468 return (copyout(&fsb, (void *)uap->buf, sizeof(fsb)));
471 /* Converts CloudABI rights to a set of Capsicum capabilities. */
473 cloudabi_convert_rights(cloudabi_rights_t in, cap_rights_t *out)
476 cap_rights_init(out);
477 #define MAPPING(cloudabi, ...) do { \
478 if (in & (cloudabi)) { \
479 cap_rights_set(out, ##__VA_ARGS__); \
486 return (ENOTCAPABLE);
491 cloudabi_sys_fd_stat_put(struct thread *td,
492 struct cloudabi_sys_fd_stat_put_args *uap)
494 cloudabi_fdstat_t fsb;
498 error = copyin(uap->buf, &fsb, sizeof(fsb));
502 if (uap->flags == CLOUDABI_FDSTAT_FLAGS) {
505 if (fsb.fs_flags & CLOUDABI_FDFLAG_APPEND)
507 if (fsb.fs_flags & CLOUDABI_FDFLAG_NONBLOCK)
508 oflags |= O_NONBLOCK;
509 if (fsb.fs_flags & (CLOUDABI_FDFLAG_SYNC |
510 CLOUDABI_FDFLAG_DSYNC | CLOUDABI_FDFLAG_RSYNC))
512 return (kern_fcntl(td, uap->fd, F_SETFL, oflags));
513 } else if (uap->flags == CLOUDABI_FDSTAT_RIGHTS) {
514 /* Convert rights. */
515 error = cloudabi_convert_rights(
516 fsb.fs_rights_base | fsb.fs_rights_inheriting, &rights);
519 return (kern_cap_rights_limit(td, uap->fd, &rights));
525 cloudabi_sys_fd_sync(struct thread *td, struct cloudabi_sys_fd_sync_args *uap)
528 return (kern_fsync(td, uap->fd, true));