]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
c2f1db8f | 2 | #pragma once |
5cb5a6ff LP |
3 | |
4 | typedef struct ExecStatus ExecStatus; | |
5 | typedef struct ExecCommand ExecCommand; | |
6 | typedef struct ExecContext ExecContext; | |
613b411c | 7 | typedef struct ExecRuntime ExecRuntime; |
9fa95f85 | 8 | typedef struct ExecParameters ExecParameters; |
e8a565cb | 9 | typedef struct Manager Manager; |
5cb5a6ff | 10 | |
71d35b6b | 11 | #include <sched.h> |
5cb5a6ff LP |
12 | #include <stdbool.h> |
13 | #include <stdio.h> | |
71d35b6b | 14 | #include <sys/capability.h> |
5cb5a6ff | 15 | |
9ce93478 | 16 | #include "cgroup-util.h" |
613b411c | 17 | #include "fdset.h" |
71d35b6b | 18 | #include "list.h" |
e93672ee | 19 | #include "missing_resource.h" |
417116f2 | 20 | #include "namespace.h" |
add00535 | 21 | #include "nsflags.h" |
5cb5a6ff | 22 | |
08f3be7a LP |
23 | #define EXEC_STDIN_DATA_MAX (64U*1024U*1024U) |
24 | ||
023a4f67 LP |
25 | typedef enum ExecUtmpMode { |
26 | EXEC_UTMP_INIT, | |
27 | EXEC_UTMP_LOGIN, | |
28 | EXEC_UTMP_USER, | |
29 | _EXEC_UTMP_MODE_MAX, | |
2307f37e | 30 | _EXEC_UTMP_MODE_INVALID = -1 |
023a4f67 LP |
31 | } ExecUtmpMode; |
32 | ||
80876c20 LP |
33 | typedef enum ExecInput { |
34 | EXEC_INPUT_NULL, | |
35 | EXEC_INPUT_TTY, | |
36 | EXEC_INPUT_TTY_FORCE, | |
37 | EXEC_INPUT_TTY_FAIL, | |
4f2d528d | 38 | EXEC_INPUT_SOCKET, |
52c239d7 | 39 | EXEC_INPUT_NAMED_FD, |
08f3be7a | 40 | EXEC_INPUT_DATA, |
2038c3f5 | 41 | EXEC_INPUT_FILE, |
80876c20 LP |
42 | _EXEC_INPUT_MAX, |
43 | _EXEC_INPUT_INVALID = -1 | |
44 | } ExecInput; | |
45 | ||
071830ff | 46 | typedef enum ExecOutput { |
80876c20 | 47 | EXEC_OUTPUT_INHERIT, |
94f04347 | 48 | EXEC_OUTPUT_NULL, |
80876c20 | 49 | EXEC_OUTPUT_TTY, |
94f04347 | 50 | EXEC_OUTPUT_SYSLOG, |
28dbc1e8 | 51 | EXEC_OUTPUT_SYSLOG_AND_CONSOLE, |
9a6bca7a | 52 | EXEC_OUTPUT_KMSG, |
28dbc1e8 | 53 | EXEC_OUTPUT_KMSG_AND_CONSOLE, |
706343f4 LP |
54 | EXEC_OUTPUT_JOURNAL, |
55 | EXEC_OUTPUT_JOURNAL_AND_CONSOLE, | |
4f2d528d | 56 | EXEC_OUTPUT_SOCKET, |
52c239d7 | 57 | EXEC_OUTPUT_NAMED_FD, |
2038c3f5 | 58 | EXEC_OUTPUT_FILE, |
566b7d23 | 59 | EXEC_OUTPUT_FILE_APPEND, |
94f04347 LP |
60 | _EXEC_OUTPUT_MAX, |
61 | _EXEC_OUTPUT_INVALID = -1 | |
071830ff LP |
62 | } ExecOutput; |
63 | ||
53f47dfc YW |
64 | typedef enum ExecPreserveMode { |
65 | EXEC_PRESERVE_NO, | |
66 | EXEC_PRESERVE_YES, | |
67 | EXEC_PRESERVE_RESTART, | |
68 | _EXEC_PRESERVE_MODE_MAX, | |
69 | _EXEC_PRESERVE_MODE_INVALID = -1 | |
70 | } ExecPreserveMode; | |
71 | ||
b1edf445 LP |
72 | typedef enum ExecKeyringMode { |
73 | EXEC_KEYRING_INHERIT, | |
74 | EXEC_KEYRING_PRIVATE, | |
75 | EXEC_KEYRING_SHARED, | |
76 | _EXEC_KEYRING_MODE_MAX, | |
77 | _EXEC_KEYRING_MODE_INVALID = -1, | |
78 | } ExecKeyringMode; | |
79 | ||
42cb05d5 | 80 | /* Contains start and exit information about an executed command. */ |
5cb5a6ff | 81 | struct ExecStatus { |
42cb05d5 | 82 | pid_t pid; |
63983207 LP |
83 | dual_timestamp start_timestamp; |
84 | dual_timestamp exit_timestamp; | |
9152c765 LP |
85 | int code; /* as in siginfo_t::si_code */ |
86 | int status; /* as in sigingo_t::si_status */ | |
5cb5a6ff LP |
87 | }; |
88 | ||
3ed0cd26 | 89 | typedef enum ExecCommandFlags { |
ce0d60a7 LP |
90 | EXEC_COMMAND_IGNORE_FAILURE = 1 << 0, |
91 | EXEC_COMMAND_FULLY_PRIVILEGED = 1 << 1, | |
92 | EXEC_COMMAND_NO_SETUID = 1 << 2, | |
93 | EXEC_COMMAND_AMBIENT_MAGIC = 1 << 3, | |
3ed0cd26 LP |
94 | } ExecCommandFlags; |
95 | ||
42cb05d5 | 96 | /* Stores information about commands we execute. Covers both configuration settings as well as runtime data. */ |
5cb5a6ff LP |
97 | struct ExecCommand { |
98 | char *path; | |
99 | char **argv; | |
034c6ed7 | 100 | ExecStatus exec_status; |
3ed0cd26 | 101 | ExecCommandFlags flags; |
034c6ed7 | 102 | LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */ |
5cb5a6ff LP |
103 | }; |
104 | ||
42cb05d5 LP |
105 | /* Encapsulates certain aspects of the runtime environment that is to be shared between multiple otherwise separate |
106 | * invocations of commands. Specifically, this allows sharing of /tmp and /var/tmp data as well as network namespaces | |
107 | * between invocations of commands. This is a reference counted object, with one reference taken by each currently | |
108 | * active command invocation that wants to share this runtime. */ | |
613b411c | 109 | struct ExecRuntime { |
cf4b2f99 | 110 | unsigned n_ref; |
613b411c | 111 | |
e8a565cb YW |
112 | Manager *manager; |
113 | ||
42cb05d5 | 114 | char *id; /* Unit id of the owner */ |
e8a565cb | 115 | |
613b411c LP |
116 | char *tmp_dir; |
117 | char *var_tmp_dir; | |
118 | ||
29206d46 LP |
119 | /* An AF_UNIX socket pair, that contains a datagram containing a file descriptor referring to the network |
120 | * namespace. */ | |
613b411c LP |
121 | int netns_storage_socket[2]; |
122 | }; | |
123 | ||
3536f49e YW |
124 | typedef enum ExecDirectoryType { |
125 | EXEC_DIRECTORY_RUNTIME = 0, | |
126 | EXEC_DIRECTORY_STATE, | |
127 | EXEC_DIRECTORY_CACHE, | |
128 | EXEC_DIRECTORY_LOGS, | |
129 | EXEC_DIRECTORY_CONFIGURATION, | |
72fd1768 LP |
130 | _EXEC_DIRECTORY_TYPE_MAX, |
131 | _EXEC_DIRECTORY_TYPE_INVALID = -1, | |
3536f49e YW |
132 | } ExecDirectoryType; |
133 | ||
134 | typedef struct ExecDirectory { | |
135 | char **paths; | |
136 | mode_t mode; | |
137 | } ExecDirectory; | |
138 | ||
42cb05d5 LP |
139 | /* Encodes configuration parameters applied to invoked commands. Does not carry runtime data, but only configuration |
140 | * changes sourced from unit files and suchlike. ExecContext objects are usually embedded into Unit objects, and do not | |
141 | * change after being loaded. */ | |
5cb5a6ff LP |
142 | struct ExecContext { |
143 | char **environment; | |
8c7be95e | 144 | char **environment_files; |
b4c14404 | 145 | char **pass_environment; |
00819cc1 | 146 | char **unset_environment; |
8c7be95e | 147 | |
517d56b1 | 148 | struct rlimit *rlimit[_RLIMIT_MAX]; |
915e6d16 | 149 | char *working_directory, *root_directory, *root_image; |
4c08c824 | 150 | bool working_directory_missing_ok; |
5f5d8eab | 151 | bool working_directory_home; |
9d58f1db LP |
152 | |
153 | mode_t umask; | |
dd6c17b1 | 154 | int oom_score_adjust; |
5cb5a6ff | 155 | int nice; |
9eba9da4 | 156 | int ioprio; |
94f04347 LP |
157 | int cpu_sched_policy; |
158 | int cpu_sched_priority; | |
9d58f1db | 159 | |
82c121a4 LP |
160 | cpu_set_t *cpuset; |
161 | unsigned cpuset_ncpus; | |
fb33a393 | 162 | |
80876c20 LP |
163 | ExecInput std_input; |
164 | ExecOutput std_output; | |
165 | ExecOutput std_error; | |
52c239d7 | 166 | char *stdio_fdname[3]; |
2038c3f5 | 167 | char *stdio_file[3]; |
80876c20 | 168 | |
08f3be7a LP |
169 | void *stdin_data; |
170 | size_t stdin_data_size; | |
80876c20 | 171 | |
d88a251b | 172 | nsec_t timer_slack_nsec; |
071830ff | 173 | |
1e22b5cd LP |
174 | bool stdio_as_fds; |
175 | ||
9d58f1db | 176 | char *tty_path; |
5cb5a6ff | 177 | |
6ea832a2 LP |
178 | bool tty_reset; |
179 | bool tty_vhangup; | |
180 | bool tty_vt_disallocate; | |
181 | ||
353e12c2 LP |
182 | bool ignore_sigpipe; |
183 | ||
61233823 | 184 | /* Since resolving these names might involve socket |
5cb5a6ff | 185 | * connections and we don't want to deadlock ourselves these |
94f04347 LP |
186 | * names are resolved on execution only and in the child |
187 | * process. */ | |
5cb5a6ff LP |
188 | char *user; |
189 | char *group; | |
190 | char **supplementary_groups; | |
9d58f1db | 191 | |
5b6319dc LP |
192 | char *pam_name; |
193 | ||
169c1bda | 194 | char *utmp_id; |
023a4f67 | 195 | ExecUtmpMode utmp_mode; |
169c1bda | 196 | |
5f8640fb | 197 | bool selinux_context_ignore; |
7b52a628 MS |
198 | char *selinux_context; |
199 | ||
eef65bf3 MS |
200 | bool apparmor_profile_ignore; |
201 | char *apparmor_profile; | |
202 | ||
2ca620c4 WC |
203 | bool smack_process_label_ignore; |
204 | char *smack_process_label; | |
205 | ||
b1edf445 LP |
206 | ExecKeyringMode keyring_mode; |
207 | ||
2a624c36 | 208 | char **read_write_paths, **read_only_paths, **inaccessible_paths; |
15ae422b | 209 | unsigned long mount_flags; |
d2d6c096 | 210 | BindMount *bind_mounts; |
da6053d0 | 211 | size_t n_bind_mounts; |
2abd4e38 | 212 | TemporaryFileSystem *temporary_filesystems; |
da6053d0 | 213 | size_t n_temporary_filesystems; |
15ae422b | 214 | |
a103496c | 215 | uint64_t capability_bounding_set; |
755d4b67 | 216 | uint64_t capability_ambient_set; |
9d58f1db LP |
217 | int secure_bits; |
218 | ||
7fab9d01 LP |
219 | int syslog_priority; |
220 | char *syslog_identifier; | |
221 | bool syslog_level_prefix; | |
222 | ||
d3070fbd LP |
223 | int log_level_max; |
224 | ||
225 | struct iovec* log_extra_fields; | |
226 | size_t n_log_extra_fields; | |
227 | ||
90fc172e AZ |
228 | usec_t log_rate_limit_interval_usec; |
229 | unsigned log_rate_limit_burst; | |
230 | ||
9d58f1db LP |
231 | bool cpu_sched_reset_on_fork; |
232 | bool non_blocking; | |
15ae422b | 233 | bool private_tmp; |
ff01d048 | 234 | bool private_network; |
7f112f50 | 235 | bool private_devices; |
d251207d | 236 | bool private_users; |
228af36f | 237 | bool private_mounts; |
1b8689f9 LP |
238 | ProtectSystem protect_system; |
239 | ProtectHome protect_home; | |
59eeb84b | 240 | bool protect_kernel_tunables; |
502d704e | 241 | bool protect_kernel_modules; |
59eeb84b | 242 | bool protect_control_groups; |
5d997827 | 243 | bool mount_apivfs; |
9d58f1db | 244 | |
8351ceae LP |
245 | bool no_new_privileges; |
246 | ||
29206d46 | 247 | bool dynamic_user; |
00d9ef85 | 248 | bool remove_ipc; |
29206d46 | 249 | |
9d58f1db LP |
250 | /* This is not exposed to the user but available |
251 | * internally. We need it to make sure that whenever we spawn | |
f00929ad | 252 | * /usr/bin/mount it is run in the same process group as us so |
9d58f1db LP |
253 | * that the autofs logic detects that it belongs to us and we |
254 | * don't enter a trigger loop. */ | |
74922904 | 255 | bool same_pgrp; |
2e22afe9 | 256 | |
ac45f971 | 257 | unsigned long personality; |
78e864e5 | 258 | bool lock_personality; |
ac45f971 | 259 | |
add00535 LP |
260 | unsigned long restrict_namespaces; /* The CLONE_NEWxyz flags permitted to the unit's processes */ |
261 | ||
8cfa775f | 262 | Hashmap *syscall_filter; |
57183d11 | 263 | Set *syscall_archs; |
17df7223 LP |
264 | int syscall_errno; |
265 | bool syscall_whitelist:1; | |
8351ceae | 266 | |
4298d0b5 LP |
267 | Set *address_families; |
268 | bool address_families_whitelist:1; | |
269 | ||
53f47dfc | 270 | ExecPreserveMode runtime_directory_preserve_mode; |
72fd1768 | 271 | ExecDirectory directories[_EXEC_DIRECTORY_TYPE_MAX]; |
e66cf1a3 | 272 | |
f4170c67 LP |
273 | bool memory_deny_write_execute; |
274 | bool restrict_realtime; | |
275 | ||
dd6c17b1 | 276 | bool oom_score_adjust_set:1; |
7fab9d01 LP |
277 | bool nice_set:1; |
278 | bool ioprio_set:1; | |
279 | bool cpu_sched_set:1; | |
5cb5a6ff LP |
280 | }; |
281 | ||
add00535 LP |
282 | static inline bool exec_context_restrict_namespaces_set(const ExecContext *c) { |
283 | assert(c); | |
284 | ||
285 | return (c->restrict_namespaces & NAMESPACE_FLAGS_ALL) != NAMESPACE_FLAGS_ALL; | |
286 | } | |
287 | ||
c39f1ce2 | 288 | typedef enum ExecFlags { |
ef31828d LP |
289 | EXEC_APPLY_SANDBOXING = 1 << 0, |
290 | EXEC_APPLY_CHROOT = 1 << 1, | |
291 | EXEC_APPLY_TTY_STDIN = 1 << 2, | |
292 | EXEC_NEW_KEYRING = 1 << 3, | |
293 | EXEC_PASS_LOG_UNIT = 1 << 4, /* Whether to pass the unit name to the service's journal stream connection */ | |
294 | EXEC_CHOWN_DIRECTORIES = 1 << 5, /* chown() the runtime/state/cache/log directories to the user we run as, under all conditions */ | |
295 | EXEC_NSS_BYPASS_BUS = 1 << 6, /* Set the SYSTEMD_NSS_BYPASS_BUS environment variable, to disable nss-systemd for dbus */ | |
296 | EXEC_CGROUP_DELEGATE = 1 << 7, | |
78f93209 LP |
297 | EXEC_IS_CONTROL = 1 << 8, |
298 | EXEC_CONTROL_CGROUP = 1 << 9, /* Place the process not in the indicated cgroup but in a subcgroup '/.control', but only EXEC_CGROUP_DELEGATE and EXEC_IS_CONTROL is set, too */ | |
c39f1ce2 | 299 | |
9c1a61ad | 300 | /* The following are not used by execute.c, but by consumers internally */ |
78f93209 LP |
301 | EXEC_PASS_FDS = 1 << 10, |
302 | EXEC_SETENV_RESULT = 1 << 11, | |
303 | EXEC_SET_WATCHDOG = 1 << 12, | |
c39f1ce2 LP |
304 | } ExecFlags; |
305 | ||
42cb05d5 LP |
306 | /* Parameters for a specific invocation of a command. This structure is put together right before a command is |
307 | * executed. */ | |
9fa95f85 | 308 | struct ExecParameters { |
a34ceba6 | 309 | char **environment; |
8dd4c05b LP |
310 | |
311 | int *fds; | |
312 | char **fd_names; | |
da6053d0 | 313 | size_t n_socket_fds; |
25b583d7 | 314 | size_t n_storage_fds; |
8dd4c05b | 315 | |
c39f1ce2 | 316 | ExecFlags flags; |
a34ceba6 | 317 | bool selinux_context_net:1; |
8dd4c05b | 318 | |
efdb0237 | 319 | CGroupMask cgroup_supported; |
9fa95f85 | 320 | const char *cgroup_path; |
8dd4c05b | 321 | |
3536f49e | 322 | char **prefix; |
8dd4c05b | 323 | |
7d5ceb64 FB |
324 | const char *confirm_spawn; |
325 | ||
9fa95f85 | 326 | usec_t watchdog_usec; |
8dd4c05b | 327 | |
9fa95f85 | 328 | int *idle_pipe; |
8dd4c05b | 329 | |
a34ceba6 LP |
330 | int stdin_fd; |
331 | int stdout_fd; | |
332 | int stderr_fd; | |
5686391b LP |
333 | |
334 | /* An fd that is closed by the execve(), and thus will result in EOF when the execve() is done */ | |
335 | int exec_fd; | |
9fa95f85 DM |
336 | }; |
337 | ||
9ce93478 | 338 | #include "unit.h" |
29206d46 | 339 | #include "dynamic-user.h" |
9ce93478 | 340 | |
f2341e0a LP |
341 | int exec_spawn(Unit *unit, |
342 | ExecCommand *command, | |
9fa95f85 DM |
343 | const ExecContext *context, |
344 | const ExecParameters *exec_params, | |
613b411c | 345 | ExecRuntime *runtime, |
29206d46 | 346 | DynamicCreds *dynamic_creds, |
81a2b7ce | 347 | pid_t *ret); |
5cb5a6ff | 348 | |
da6053d0 | 349 | void exec_command_done_array(ExecCommand *c, size_t n); |
f1acf85a | 350 | ExecCommand* exec_command_free_list(ExecCommand *c); |
da6053d0 | 351 | void exec_command_free_array(ExecCommand **c, size_t n); |
6a1d4d9f LP |
352 | void exec_command_reset_status_array(ExecCommand *c, size_t n); |
353 | void exec_command_reset_status_list_array(ExecCommand **c, size_t n); | |
44d8db9e | 354 | void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix); |
a6a80b4f | 355 | void exec_command_append_list(ExecCommand **l, ExecCommand *e); |
7593c3ec LP |
356 | int exec_command_set(ExecCommand *c, const char *path, ...) _sentinel_; |
357 | int exec_command_append(ExecCommand *c, const char *path, ...) _sentinel_; | |
44d8db9e | 358 | |
034c6ed7 | 359 | void exec_context_init(ExecContext *c); |
613b411c | 360 | void exec_context_done(ExecContext *c); |
34cf6c43 | 361 | void exec_context_dump(const ExecContext *c, FILE* f, const char *prefix); |
5cb5a6ff | 362 | |
34cf6c43 | 363 | int exec_context_destroy_runtime_directory(const ExecContext *c, const char *runtime_root); |
e66cf1a3 | 364 | |
52c239d7 | 365 | const char* exec_context_fdname(const ExecContext *c, int fd_index); |
8c7be95e | 366 | |
34cf6c43 YW |
367 | bool exec_context_may_touch_console(const ExecContext *c); |
368 | bool exec_context_maintains_privileges(const ExecContext *c); | |
6ac8fdc9 | 369 | |
34cf6c43 | 370 | int exec_context_get_effective_ioprio(const ExecContext *c); |
7f452159 | 371 | |
d3070fbd LP |
372 | void exec_context_free_log_extra_fields(ExecContext *c); |
373 | ||
b58b4116 | 374 | void exec_status_start(ExecStatus *s, pid_t pid); |
34cf6c43 YW |
375 | void exec_status_exit(ExecStatus *s, const ExecContext *context, pid_t pid, int code, int status); |
376 | void exec_status_dump(const ExecStatus *s, FILE *f, const char *prefix); | |
6a1d4d9f | 377 | void exec_status_reset(ExecStatus *s); |
5cb5a6ff | 378 | |
e8a565cb YW |
379 | int exec_runtime_acquire(Manager *m, const ExecContext *c, const char *name, bool create, ExecRuntime **ret); |
380 | ExecRuntime *exec_runtime_unref(ExecRuntime *r, bool destroy); | |
613b411c | 381 | |
e8a565cb YW |
382 | int exec_runtime_serialize(const Manager *m, FILE *f, FDSet *fds); |
383 | int exec_runtime_deserialize_compat(Unit *u, const char *key, const char *value, FDSet *fds); | |
384 | void exec_runtime_deserialize_one(Manager *m, const char *value, FDSet *fds); | |
385 | void exec_runtime_vacuum(Manager *m); | |
613b411c | 386 | |
b9c04eaf YW |
387 | void exec_params_clear(ExecParameters *p); |
388 | ||
44a6b1b6 ZJS |
389 | const char* exec_output_to_string(ExecOutput i) _const_; |
390 | ExecOutput exec_output_from_string(const char *s) _pure_; | |
94f04347 | 391 | |
44a6b1b6 ZJS |
392 | const char* exec_input_to_string(ExecInput i) _const_; |
393 | ExecInput exec_input_from_string(const char *s) _pure_; | |
023a4f67 LP |
394 | |
395 | const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_; | |
396 | ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_; | |
53f47dfc YW |
397 | |
398 | const char* exec_preserve_mode_to_string(ExecPreserveMode i) _const_; | |
399 | ExecPreserveMode exec_preserve_mode_from_string(const char *s) _pure_; | |
3536f49e | 400 | |
b1edf445 LP |
401 | const char* exec_keyring_mode_to_string(ExecKeyringMode i) _const_; |
402 | ExecKeyringMode exec_keyring_mode_from_string(const char *s) _pure_; | |
403 | ||
3536f49e YW |
404 | const char* exec_directory_type_to_string(ExecDirectoryType i) _const_; |
405 | ExecDirectoryType exec_directory_type_from_string(const char *s) _pure_; |