Elly Jones | e58176c | 2012-01-23 11:46:17 -0500 | [diff] [blame] | 1 | /* Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 2 | * Use of this source code is governed by a BSD-style license that can be |
Will Drewry | 32ac9f5 | 2011-08-18 21:36:27 -0500 | [diff] [blame] | 3 | * found in the LICENSE file. |
| 4 | */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 5 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 6 | /* |
| 7 | * The general pattern of use here: |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 8 | * 1) Construct a minijail with minijail_new() |
| 9 | * 2) Apply the desired restrictions to it |
| 10 | * 3) Enter it, which locks the current process inside it, or: |
| 11 | * 3) Run a process inside it |
| 12 | * 4) Destroy it. |
| 13 | */ |
| 14 | |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 15 | #ifndef _LIBMINIJAIL_H_ |
| 16 | #define _LIBMINIJAIL_H_ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 17 | |
| 18 | #include <stdint.h> |
| 19 | #include <sys/types.h> |
| 20 | |
| 21 | #ifdef __cplusplus |
| 22 | extern "C" { |
| 23 | #endif |
| 24 | |
| 25 | enum { |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 26 | MINIJAIL_ERR_PRELOAD = 252, |
| 27 | MINIJAIL_ERR_JAIL = 253, |
| 28 | MINIJAIL_ERR_INIT = 254, |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 29 | }; |
| 30 | |
| 31 | struct minijail; |
| 32 | |
| 33 | /* Allocates a new minijail with no restrictions. */ |
| 34 | struct minijail *minijail_new(void); |
| 35 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 36 | /* |
| 37 | * These functions add restrictions to the minijail. They are not applied until |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 38 | * minijail_enter() is called. See the documentation in minijail0.1 for |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 39 | * explanations in detail of what the restrictions do. |
| 40 | */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 41 | void minijail_change_uid(struct minijail *j, uid_t uid); |
| 42 | void minijail_change_gid(struct minijail *j, gid_t gid); |
Jorge Lucangeli Obes | d16ac49 | 2015-12-03 14:44:35 -0800 | [diff] [blame] | 43 | /* Copies |list|. */ |
Jorge Lucangeli Obes | bc67f44 | 2016-01-08 14:43:45 -0800 | [diff] [blame] | 44 | void minijail_set_supplementary_gids(struct minijail *j, size_t size, |
| 45 | const gid_t *list); |
Will Drewry | 2ddaad0 | 2011-09-16 11:36:08 -0500 | [diff] [blame] | 46 | /* Stores user to change to and copies |user| for internal consistency. */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 47 | int minijail_change_user(struct minijail *j, const char *user); |
Will Drewry | 2ddaad0 | 2011-09-16 11:36:08 -0500 | [diff] [blame] | 48 | /* Does not take ownership of |group|. */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 49 | int minijail_change_group(struct minijail *j, const char *group); |
| 50 | void minijail_use_seccomp(struct minijail *j); |
Jorge Lucangeli Obes | c2c9bcc | 2012-05-01 09:30:24 -0700 | [diff] [blame] | 51 | void minijail_no_new_privs(struct minijail *j); |
Will Drewry | 32ac9f5 | 2011-08-18 21:36:27 -0500 | [diff] [blame] | 52 | void minijail_use_seccomp_filter(struct minijail *j); |
| 53 | void minijail_parse_seccomp_filters(struct minijail *j, const char *path); |
Jorge Lucangeli Obes | bda833c | 2012-07-31 16:25:56 -0700 | [diff] [blame] | 54 | void minijail_log_seccomp_filter_failures(struct minijail *j); |
Jorge Lucangeli Obes | f9fcdbe | 2016-02-19 15:04:09 -0800 | [diff] [blame] | 55 | /* 'minijail_use_caps' and 'minijail_capbset_drop' are mutually exclusive. */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 56 | void minijail_use_caps(struct minijail *j, uint64_t capmask); |
Jorge Lucangeli Obes | f9fcdbe | 2016-02-19 15:04:09 -0800 | [diff] [blame] | 57 | void minijail_capbset_drop(struct minijail *j, uint64_t capmask); |
Peter Qiu | 2860c46 | 2015-12-16 15:13:06 -0800 | [diff] [blame] | 58 | void minijail_reset_signal_mask(struct minijail *j); |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 59 | void minijail_namespace_vfs(struct minijail *j); |
Jorge Lucangeli Obes | 1563b5b | 2014-07-10 07:01:53 -0700 | [diff] [blame] | 60 | void minijail_namespace_enter_vfs(struct minijail *j, const char *ns_path); |
Jorge Lucangeli Obes | a521bee | 2016-03-03 13:47:57 -0800 | [diff] [blame] | 61 | /* |
| 62 | * This option is *dangerous* as it negates most of the functionality of |
| 63 | * minijail_namespace_vfs(). You very likely don't need this. |
| 64 | */ |
| 65 | void minijail_skip_remount_private(struct minijail *j); |
Dylan Reid | f794247 | 2015-11-18 17:55:26 -0800 | [diff] [blame] | 66 | void minijail_namespace_ipc(struct minijail *j); |
Elly Fong-Jones | 6c08630 | 2013-03-20 17:15:28 -0400 | [diff] [blame] | 67 | void minijail_namespace_net(struct minijail *j); |
Dylan Reid | 1102f5a | 2015-09-15 11:52:20 -0700 | [diff] [blame] | 68 | void minijail_namespace_enter_net(struct minijail *j, const char *ns_path); |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 69 | /* |
| 70 | * Implies namespace_vfs and remount_proc_readonly. |
Elly Jones | 761b741 | 2012-06-13 15:49:52 -0400 | [diff] [blame] | 71 | * WARNING: this is NOT THREAD SAFE. See the block comment in </libminijail.c>. |
| 72 | */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 73 | void minijail_namespace_pids(struct minijail *j); |
Yu-Hsi Chiang | 10e9123 | 2015-08-05 14:40:45 +0800 | [diff] [blame] | 74 | void minijail_namespace_user(struct minijail *j); |
| 75 | int minijail_uidmap(struct minijail *j, const char *uidmap); |
| 76 | int minijail_gidmap(struct minijail *j, const char *gidmap); |
Dylan Reid | 791f577 | 2015-09-14 20:02:42 -0700 | [diff] [blame] | 77 | void minijail_remount_proc_readonly(struct minijail *j); |
Yu-Hsi Chiang | 3e954ec | 2015-07-28 16:48:14 +0800 | [diff] [blame] | 78 | void minijail_run_as_init(struct minijail *j); |
Yu-Hsi Chiang | 3cc05ea | 2015-08-11 11:23:17 +0800 | [diff] [blame] | 79 | int minijail_write_pid_file(struct minijail *j, const char *path); |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 80 | void minijail_inherit_usergroups(struct minijail *j); |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 81 | /* |
| 82 | * Changes the jailed process's syscall table to the alt_syscall table |
Andrew Bresticker | eac2894 | 2015-11-11 16:04:46 -0800 | [diff] [blame] | 83 | * named |table|. |
| 84 | */ |
| 85 | int minijail_use_alt_syscall(struct minijail *j, const char *table); |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 86 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 87 | /* |
Dylan Reid | 605ce7f | 2016-01-19 19:21:00 -0800 | [diff] [blame] | 88 | * Adds the jailed process to the cgroup given by |path|. |path| should be the |
| 89 | * full path to the cgroups "tasks" file. |
| 90 | * Example: /sys/fs/cgroup/cpu/jailed_procs/tasks adds to the "jailed_procs" cpu |
| 91 | * cgroup. |
| 92 | */ |
| 93 | int minijail_add_to_cgroup(struct minijail *j, const char *path); |
| 94 | |
| 95 | /* |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 96 | * minijail_enter_chroot: enables chroot() restriction for @j |
Elly Jones | 51a5b6c | 2011-10-12 19:09:26 -0400 | [diff] [blame] | 97 | * @j minijail to apply restriction to |
| 98 | * @dir directory to chroot() to. Owned by caller. |
| 99 | * |
| 100 | * Enters @dir, binding all bind mounts specified with minijail_bind() into |
| 101 | * place. Requires @dir to contain all necessary directories for bind mounts |
| 102 | * (i.e., if you have requested a bind mount at /etc, /etc must exist in @dir.) |
| 103 | * |
| 104 | * Returns 0 on success. |
| 105 | */ |
| 106 | int minijail_enter_chroot(struct minijail *j, const char *dir); |
Yu-Hsi Chiang | 64d65a7 | 2015-08-13 17:43:27 +0800 | [diff] [blame] | 107 | int minijail_enter_pivot_root(struct minijail *j, const char *dir); |
Elly Jones | 51a5b6c | 2011-10-12 19:09:26 -0400 | [diff] [blame] | 108 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 109 | /* |
| 110 | * minijail_get_original_path: returns the path of a given file outside of the |
Dylan Reid | 08946cc | 2015-09-16 19:10:57 -0700 | [diff] [blame] | 111 | * chroot. |
| 112 | * @j minijail to obtain the path from. |
| 113 | * @chroot_path path inside of the chroot() to. |
| 114 | * |
| 115 | * When executing a binary in a chroot or pivot_root, return path to the binary |
| 116 | * outside of the chroot. |
| 117 | * |
| 118 | * Returns a string containing the path. This must be freed by the caller. |
| 119 | */ |
| 120 | char *minijail_get_original_path(struct minijail *j, const char *chroot_path); |
| 121 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 122 | /* |
| 123 | * minijail_mount_tmp: enables mounting of a tmpfs filesystem on /tmp. |
Lee Campbell | 11af062 | 2014-05-22 12:36:04 -0700 | [diff] [blame] | 124 | * As be rules of bind mounts, /tmp must exist in chroot. |
| 125 | */ |
| 126 | void minijail_mount_tmp(struct minijail *j); |
| 127 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 128 | /* |
| 129 | * minijail_mount: when entering minijail @j, mounts @src at @dst with @flags |
Dylan Reid | 648b220 | 2015-10-23 00:50:00 -0700 | [diff] [blame] | 130 | * @j minijail to bind inside |
| 131 | * @src source to bind |
| 132 | * @dest location to bind (inside chroot) |
| 133 | * @type type of filesystem |
| 134 | * @flags flags passed to mount |
| 135 | * |
| 136 | * This may be called multiple times; all bindings will be applied in the order |
| 137 | * of minijail_mount() calls. |
| 138 | */ |
| 139 | int minijail_mount(struct minijail *j, const char *src, const char *dest, |
Jorge Lucangeli Obes | d16ac49 | 2015-12-03 14:44:35 -0800 | [diff] [blame] | 140 | const char *type, unsigned long flags); |
Dylan Reid | 648b220 | 2015-10-23 00:50:00 -0700 | [diff] [blame] | 141 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 142 | /* |
| 143 | * minijail_bind: bind-mounts @src into @j as @dest, optionally writeable |
Elly Jones | 51a5b6c | 2011-10-12 19:09:26 -0400 | [diff] [blame] | 144 | * @j minijail to bind inside |
| 145 | * @src source to bind |
| 146 | * @dest location to bind (inside chroot) |
| 147 | * @writeable 1 if the bind mount should be writeable |
| 148 | * |
| 149 | * This may be called multiple times; all bindings will be applied in the order |
| 150 | * of minijail_bind() calls. |
| 151 | */ |
| 152 | int minijail_bind(struct minijail *j, const char *src, const char *dest, |
Jorge Lucangeli Obes | 2f61ee4 | 2014-06-16 11:08:18 -0700 | [diff] [blame] | 153 | int writeable); |
Elly Jones | 51a5b6c | 2011-10-12 19:09:26 -0400 | [diff] [blame] | 154 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 155 | /* |
| 156 | * Lock this process into the given minijail. Note that this procedure cannot fail, |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 157 | * since there is no way to undo privilege-dropping; therefore, if any part of |
| 158 | * the privilege-drop fails, minijail_enter() will abort the entire process. |
| 159 | * |
| 160 | * Some restrictions cannot be enabled this way (pid namespaces) and attempting |
| 161 | * to do so will cause an abort. |
| 162 | */ |
| 163 | void minijail_enter(const struct minijail *j); |
| 164 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 165 | /* |
| 166 | * Run the specified command in the given minijail, execve(2)-style. This is |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 167 | * required if minijail_namespace_pids() was used. |
| 168 | */ |
| 169 | int minijail_run(struct minijail *j, const char *filename, |
| 170 | char *const argv[]); |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 171 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 172 | /* |
| 173 | * Run the specified command in the given minijail, execve(2)-style. |
Jorge Lucangeli Obes | 5471450 | 2015-09-30 10:08:45 -0700 | [diff] [blame] | 174 | * Used with static binaries, or on systems without support for LD_PRELOAD. |
Lee Campbell | 1e4fc6a | 2014-06-06 17:40:02 -0700 | [diff] [blame] | 175 | */ |
Jorge Lucangeli Obes | 5471450 | 2015-09-30 10:08:45 -0700 | [diff] [blame] | 176 | int minijail_run_no_preload(struct minijail *j, const char *filename, |
| 177 | char *const argv[]); |
Lee Campbell | 1e4fc6a | 2014-06-06 17:40:02 -0700 | [diff] [blame] | 178 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 179 | /* |
| 180 | * Run the specified command in the given minijail, execve(2)-style. |
Jorge Lucangeli Obes | 9807d03 | 2012-04-17 13:36:00 -0700 | [diff] [blame] | 181 | * Update |*pchild_pid| with the pid of the child. |
| 182 | */ |
| 183 | int minijail_run_pid(struct minijail *j, const char *filename, |
| 184 | char *const argv[], pid_t *pchild_pid); |
| 185 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 186 | /* |
| 187 | * Run the specified command in the given minijail, execve(2)-style. |
Jorge Lucangeli Obes | df4bd35 | 2012-08-29 19:12:28 -0700 | [diff] [blame] | 188 | * Update |*pstdin_fd| with a fd that allows writing to the child's |
| 189 | * standard input. |
| 190 | */ |
| 191 | int minijail_run_pipe(struct minijail *j, const char *filename, |
| 192 | char *const argv[], int *pstdin_fd); |
| 193 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 194 | /* |
| 195 | * Run the specified command in the given minijail, execve(2)-style. |
Jorge Lucangeli Obes | df4bd35 | 2012-08-29 19:12:28 -0700 | [diff] [blame] | 196 | * Update |*pchild_pid| with the pid of the child. |
| 197 | * Update |*pstdin_fd| with a fd that allows writing to the child's |
| 198 | * standard input. |
Jorge Lucangeli Obes | 339a113 | 2013-02-15 16:53:47 -0800 | [diff] [blame] | 199 | * Update |*pstdout_fd| with a fd that allows reading from the child's |
| 200 | * standard output. |
| 201 | * Update |*pstderr_fd| with a fd that allows reading from the child's |
| 202 | * standard error. |
| 203 | */ |
| 204 | int minijail_run_pid_pipes(struct minijail *j, const char *filename, |
| 205 | char *const argv[], pid_t *pchild_pid, |
| 206 | int *pstdin_fd, int *pstdout_fd, int *pstderr_fd); |
| 207 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 208 | /* |
| 209 | * Run the specified command in the given minijail, execve(2)-style. |
Samuel Tan | 63187f4 | 2015-10-16 13:01:53 -0700 | [diff] [blame] | 210 | * Update |*pchild_pid| with the pid of the child. |
| 211 | * Update |*pstdin_fd| with a fd that allows writing to the child's |
| 212 | * standard input. |
| 213 | * Update |*pstdout_fd| with a fd that allows reading from the child's |
| 214 | * standard output. |
| 215 | * Update |*pstderr_fd| with a fd that allows reading from the child's |
| 216 | * standard error. |
| 217 | * Used with static binaries, or on systems without support for LD_PRELOAD. |
| 218 | */ |
| 219 | int minijail_run_pid_pipes_no_preload(struct minijail *j, const char *filename, |
| 220 | char *const argv[], pid_t *pchild_pid, |
Jorge Lucangeli Obes | 43a6a86 | 2015-12-04 14:53:36 -0800 | [diff] [blame] | 221 | int *pstdin_fd, int *pstdout_fd, |
| 222 | int *pstderr_fd); |
Samuel Tan | 63187f4 | 2015-10-16 13:01:53 -0700 | [diff] [blame] | 223 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 224 | /* |
| 225 | * Kill the specified minijail. The minijail must have been created with pid |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 226 | * namespacing; if it was, all processes inside it are atomically killed. |
| 227 | */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 228 | int minijail_kill(struct minijail *j); |
| 229 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 230 | /* |
| 231 | * Wait for all processed in the specified minijail to exit. Returns the exit |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 232 | * status of the _first_ process spawned in the jail. |
| 233 | */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 234 | int minijail_wait(struct minijail *j); |
| 235 | |
Jorge Lucangeli Obes | d0a6e2f | 2015-11-24 14:21:21 -0800 | [diff] [blame] | 236 | /* |
| 237 | * Frees the given minijail. It does not matter if the process is inside the minijail or |
| 238 | * not. |
| 239 | */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 240 | void minijail_destroy(struct minijail *j); |
| 241 | |
| 242 | #ifdef __cplusplus |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 243 | }; /* extern "C" */ |
Elly Jones | cd7a904 | 2011-07-22 13:56:51 -0400 | [diff] [blame] | 244 | #endif |
| 245 | |
Elly Jones | e1749eb | 2011-10-07 13:54:59 -0400 | [diff] [blame] | 246 | #endif /* !_LIBMINIJAIL_H_ */ |