1 /* SPDX-License-Identifier: LGPL-2.1+ */
4 typedef struct ExecStatus ExecStatus
;
5 typedef struct ExecCommand ExecCommand
;
6 typedef struct ExecContext ExecContext
;
7 typedef struct ExecRuntime ExecRuntime
;
8 typedef struct ExecParameters ExecParameters
;
9 typedef struct Manager Manager
;
14 #include <sys/capability.h>
16 #include "cgroup-util.h"
20 #include "namespace.h"
23 #define EXEC_STDIN_DATA_MAX (64U*1024U*1024U)
25 typedef enum ExecUtmpMode
{
30 _EXEC_UTMP_MODE_INVALID
= -1
33 typedef enum ExecInput
{
43 _EXEC_INPUT_INVALID
= -1
46 typedef enum ExecOutput
{
51 EXEC_OUTPUT_SYSLOG_AND_CONSOLE
,
53 EXEC_OUTPUT_KMSG_AND_CONSOLE
,
55 EXEC_OUTPUT_JOURNAL_AND_CONSOLE
,
59 EXEC_OUTPUT_FILE_APPEND
,
61 _EXEC_OUTPUT_INVALID
= -1
64 typedef enum ExecPreserveMode
{
67 EXEC_PRESERVE_RESTART
,
68 _EXEC_PRESERVE_MODE_MAX
,
69 _EXEC_PRESERVE_MODE_INVALID
= -1
72 typedef enum ExecKeyringMode
{
76 _EXEC_KEYRING_MODE_MAX
,
77 _EXEC_KEYRING_MODE_INVALID
= -1,
80 /* Contains start and exit information about an executed command. */
83 dual_timestamp start_timestamp
;
84 dual_timestamp exit_timestamp
;
85 int code
; /* as in siginfo_t::si_code */
86 int status
; /* as in sigingo_t::si_status */
89 typedef enum ExecCommandFlags
{
90 EXEC_COMMAND_IGNORE_FAILURE
= 1,
91 EXEC_COMMAND_FULLY_PRIVILEGED
= 2,
92 EXEC_COMMAND_NO_SETUID
= 4,
93 EXEC_COMMAND_AMBIENT_MAGIC
= 8,
96 /* Stores information about commands we execute. Covers both configuration settings as well as runtime data. */
100 ExecStatus exec_status
;
101 ExecCommandFlags flags
;
102 LIST_FIELDS(ExecCommand
, command
); /* useful for chaining commands */
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. */
114 char *id
; /* Unit id of the owner */
119 /* An AF_UNIX socket pair, that contains a datagram containing a file descriptor referring to the network
121 int netns_storage_socket
[2];
124 typedef enum ExecDirectoryType
{
125 EXEC_DIRECTORY_RUNTIME
= 0,
126 EXEC_DIRECTORY_STATE
,
127 EXEC_DIRECTORY_CACHE
,
129 EXEC_DIRECTORY_CONFIGURATION
,
130 _EXEC_DIRECTORY_TYPE_MAX
,
131 _EXEC_DIRECTORY_TYPE_INVALID
= -1,
134 typedef struct ExecDirectory
{
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. */
144 char **environment_files
;
145 char **pass_environment
;
146 char **unset_environment
;
148 struct rlimit
*rlimit
[_RLIMIT_MAX
];
149 char *working_directory
, *root_directory
, *root_image
;
150 bool working_directory_missing_ok
;
151 bool working_directory_home
;
154 int oom_score_adjust
;
157 int cpu_sched_policy
;
158 int cpu_sched_priority
;
161 unsigned cpuset_ncpus
;
164 ExecOutput std_output
;
165 ExecOutput std_error
;
166 char *stdio_fdname
[3];
170 size_t stdin_data_size
;
172 nsec_t timer_slack_nsec
;
180 bool tty_vt_disallocate
;
184 /* Since resolving these names might involve socket
185 * connections and we don't want to deadlock ourselves these
186 * names are resolved on execution only and in the child
190 char **supplementary_groups
;
195 ExecUtmpMode utmp_mode
;
197 bool selinux_context_ignore
;
198 char *selinux_context
;
200 bool apparmor_profile_ignore
;
201 char *apparmor_profile
;
203 bool smack_process_label_ignore
;
204 char *smack_process_label
;
206 ExecKeyringMode keyring_mode
;
208 char **read_write_paths
, **read_only_paths
, **inaccessible_paths
;
209 unsigned long mount_flags
;
210 BindMount
*bind_mounts
;
211 size_t n_bind_mounts
;
212 TemporaryFileSystem
*temporary_filesystems
;
213 size_t n_temporary_filesystems
;
215 uint64_t capability_bounding_set
;
216 uint64_t capability_ambient_set
;
220 char *syslog_identifier
;
221 bool syslog_level_prefix
;
225 struct iovec
* log_extra_fields
;
226 size_t n_log_extra_fields
;
228 bool cpu_sched_reset_on_fork
;
231 bool private_network
;
232 bool private_devices
;
235 ProtectSystem protect_system
;
236 ProtectHome protect_home
;
237 bool protect_kernel_tunables
;
238 bool protect_kernel_modules
;
239 bool protect_control_groups
;
242 bool no_new_privileges
;
247 /* This is not exposed to the user but available
248 * internally. We need it to make sure that whenever we spawn
249 * /usr/bin/mount it is run in the same process group as us so
250 * that the autofs logic detects that it belongs to us and we
251 * don't enter a trigger loop. */
254 unsigned long personality
;
255 bool lock_personality
;
257 unsigned long restrict_namespaces
; /* The CLONE_NEWxyz flags permitted to the unit's processes */
259 Hashmap
*syscall_filter
;
262 bool syscall_whitelist
:1;
264 Set
*address_families
;
265 bool address_families_whitelist
:1;
267 ExecPreserveMode runtime_directory_preserve_mode
;
268 ExecDirectory directories
[_EXEC_DIRECTORY_TYPE_MAX
];
270 bool memory_deny_write_execute
;
271 bool restrict_realtime
;
273 bool oom_score_adjust_set
:1;
276 bool cpu_sched_set
:1;
279 static inline bool exec_context_restrict_namespaces_set(const ExecContext
*c
) {
282 return (c
->restrict_namespaces
& NAMESPACE_FLAGS_ALL
) != NAMESPACE_FLAGS_ALL
;
285 typedef enum ExecFlags
{
286 EXEC_APPLY_SANDBOXING
= 1 << 0,
287 EXEC_APPLY_CHROOT
= 1 << 1,
288 EXEC_APPLY_TTY_STDIN
= 1 << 2,
289 EXEC_NEW_KEYRING
= 1 << 3,
290 EXEC_PASS_LOG_UNIT
= 1 << 4, /* Whether to pass the unit name to the service's journal stream connection */
291 EXEC_CHOWN_DIRECTORIES
= 1 << 5, /* chown() the runtime/state/cache/log directories to the user we run as, under all conditions */
292 EXEC_NSS_BYPASS_BUS
= 1 << 6, /* Set the SYSTEMD_NSS_BYPASS_BUS environment variable, to disable nss-systemd for dbus */
293 EXEC_CGROUP_DELEGATE
= 1 << 7,
295 /* The following are not used by execute.c, but by consumers internally */
296 EXEC_PASS_FDS
= 1 << 8,
297 EXEC_IS_CONTROL
= 1 << 9,
298 EXEC_SETENV_RESULT
= 1 << 10,
299 EXEC_SET_WATCHDOG
= 1 << 11,
302 /* Parameters for a specific invocation of a command. This structure is put together right before a command is
304 struct ExecParameters
{
309 size_t n_storage_fds
;
313 bool selinux_context_net
:1;
315 CGroupMask cgroup_supported
;
316 const char *cgroup_path
;
320 const char *confirm_spawn
;
322 usec_t watchdog_usec
;
332 #include "dynamic-user.h"
334 int exec_spawn(Unit
*unit
,
335 ExecCommand
*command
,
336 const ExecContext
*context
,
337 const ExecParameters
*exec_params
,
338 ExecRuntime
*runtime
,
339 DynamicCreds
*dynamic_creds
,
342 void exec_command_done_array(ExecCommand
*c
, size_t n
);
343 ExecCommand
* exec_command_free_list(ExecCommand
*c
);
344 void exec_command_free_array(ExecCommand
**c
, size_t n
);
345 void exec_command_reset_status_array(ExecCommand
*c
, size_t n
);
346 void exec_command_reset_status_list_array(ExecCommand
**c
, size_t n
);
347 void exec_command_dump_list(ExecCommand
*c
, FILE *f
, const char *prefix
);
348 void exec_command_append_list(ExecCommand
**l
, ExecCommand
*e
);
349 int exec_command_set(ExecCommand
*c
, const char *path
, ...);
350 int exec_command_append(ExecCommand
*c
, const char *path
, ...);
352 void exec_context_init(ExecContext
*c
);
353 void exec_context_done(ExecContext
*c
);
354 void exec_context_dump(const ExecContext
*c
, FILE* f
, const char *prefix
);
356 int exec_context_destroy_runtime_directory(const ExecContext
*c
, const char *runtime_root
);
358 const char* exec_context_fdname(const ExecContext
*c
, int fd_index
);
360 bool exec_context_may_touch_console(const ExecContext
*c
);
361 bool exec_context_maintains_privileges(const ExecContext
*c
);
363 int exec_context_get_effective_ioprio(const ExecContext
*c
);
365 void exec_context_free_log_extra_fields(ExecContext
*c
);
367 void exec_status_start(ExecStatus
*s
, pid_t pid
);
368 void exec_status_exit(ExecStatus
*s
, const ExecContext
*context
, pid_t pid
, int code
, int status
);
369 void exec_status_dump(const ExecStatus
*s
, FILE *f
, const char *prefix
);
370 void exec_status_reset(ExecStatus
*s
);
372 int exec_runtime_acquire(Manager
*m
, const ExecContext
*c
, const char *name
, bool create
, ExecRuntime
**ret
);
373 ExecRuntime
*exec_runtime_unref(ExecRuntime
*r
, bool destroy
);
375 int exec_runtime_serialize(const Manager
*m
, FILE *f
, FDSet
*fds
);
376 int exec_runtime_deserialize_compat(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
);
377 void exec_runtime_deserialize_one(Manager
*m
, const char *value
, FDSet
*fds
);
378 void exec_runtime_vacuum(Manager
*m
);
380 const char* exec_output_to_string(ExecOutput i
) _const_
;
381 ExecOutput
exec_output_from_string(const char *s
) _pure_
;
383 const char* exec_input_to_string(ExecInput i
) _const_
;
384 ExecInput
exec_input_from_string(const char *s
) _pure_
;
386 const char* exec_utmp_mode_to_string(ExecUtmpMode i
) _const_
;
387 ExecUtmpMode
exec_utmp_mode_from_string(const char *s
) _pure_
;
389 const char* exec_preserve_mode_to_string(ExecPreserveMode i
) _const_
;
390 ExecPreserveMode
exec_preserve_mode_from_string(const char *s
) _pure_
;
392 const char* exec_keyring_mode_to_string(ExecKeyringMode i
) _const_
;
393 ExecKeyringMode
exec_keyring_mode_from_string(const char *s
) _pure_
;
395 const char* exec_directory_type_to_string(ExecDirectoryType i
) _const_
;
396 ExecDirectoryType
exec_directory_type_from_string(const char *s
) _pure_
;