1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
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"
17 #include "coredump-util.h"
18 #include "cpu-set-util.h"
19 #include "exec-util.h"
22 #include "missing_resource.h"
23 #include "namespace.h"
25 #include "numa-util.h"
26 #include "open-file.h"
27 #include "path-util.h"
29 #include "time-util.h"
31 #define EXEC_STDIN_DATA_MAX (64U*1024U*1024U)
33 typedef enum ExecUtmpMode
{
38 _EXEC_UTMP_MODE_INVALID
= -EINVAL
,
41 typedef enum ExecInput
{
51 _EXEC_INPUT_INVALID
= -EINVAL
,
54 typedef enum ExecOutput
{
59 EXEC_OUTPUT_KMSG_AND_CONSOLE
,
61 EXEC_OUTPUT_JOURNAL_AND_CONSOLE
,
65 EXEC_OUTPUT_FILE_APPEND
,
66 EXEC_OUTPUT_FILE_TRUNCATE
,
68 _EXEC_OUTPUT_INVALID
= -EINVAL
,
71 typedef enum ExecPreserveMode
{
74 EXEC_PRESERVE_RESTART
,
75 _EXEC_PRESERVE_MODE_MAX
,
76 _EXEC_PRESERVE_MODE_INVALID
= -EINVAL
,
79 typedef enum ExecKeyringMode
{
83 _EXEC_KEYRING_MODE_MAX
,
84 _EXEC_KEYRING_MODE_INVALID
= -EINVAL
,
87 /* Contains start and exit information about an executed command. */
89 dual_timestamp start_timestamp
;
90 dual_timestamp exit_timestamp
;
92 int code
; /* as in siginfo_t::si_code */
93 int status
; /* as in siginfo_t::si_status */
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];
123 /* Like netns_storage_socket, but the file descriptor is referring to the IPC namespace. */
124 int ipcns_storage_socket
[2];
127 typedef enum ExecDirectoryType
{
128 EXEC_DIRECTORY_RUNTIME
= 0,
129 EXEC_DIRECTORY_STATE
,
130 EXEC_DIRECTORY_CACHE
,
132 EXEC_DIRECTORY_CONFIGURATION
,
133 _EXEC_DIRECTORY_TYPE_MAX
,
134 _EXEC_DIRECTORY_TYPE_INVALID
= -EINVAL
,
137 typedef struct ExecDirectoryItem
{
143 typedef struct ExecDirectory
{
146 ExecDirectoryItem
*items
;
149 typedef enum ExecCleanMask
{
150 /* In case you wonder why the bitmask below doesn't use "directory" in its name: we want to keep this
151 * generic so that .timer timestamp files can nicely be covered by this too, and similar. */
152 EXEC_CLEAN_RUNTIME
= 1U << EXEC_DIRECTORY_RUNTIME
,
153 EXEC_CLEAN_STATE
= 1U << EXEC_DIRECTORY_STATE
,
154 EXEC_CLEAN_CACHE
= 1U << EXEC_DIRECTORY_CACHE
,
155 EXEC_CLEAN_LOGS
= 1U << EXEC_DIRECTORY_LOGS
,
156 EXEC_CLEAN_CONFIGURATION
= 1U << EXEC_DIRECTORY_CONFIGURATION
,
158 EXEC_CLEAN_ALL
= (1U << _EXEC_DIRECTORY_TYPE_MAX
) - 1,
159 _EXEC_CLEAN_MASK_INVALID
= -EINVAL
,
162 /* A credential configured with LoadCredential= */
163 typedef struct ExecLoadCredential
{
166 } ExecLoadCredential
;
168 /* A credential configured with SetCredential= */
169 typedef struct ExecSetCredential
{
176 /* Encodes configuration parameters applied to invoked commands. Does not carry runtime data, but only configuration
177 * changes sourced from unit files and suchlike. ExecContext objects are usually embedded into Unit objects, and do not
178 * change after being loaded. */
181 char **environment_files
;
182 char **pass_environment
;
183 char **unset_environment
;
185 struct rlimit
*rlimit
[_RLIMIT_MAX
];
186 char *working_directory
, *root_directory
, *root_image
, *root_verity
, *root_hash_path
, *root_hash_sig_path
;
187 void *root_hash
, *root_hash_sig
;
188 size_t root_hash_size
, root_hash_sig_size
;
189 LIST_HEAD(MountOptions
, root_image_options
);
190 bool working_directory_missing_ok
:1;
191 bool working_directory_home
:1;
193 bool oom_score_adjust_set
:1;
194 bool coredump_filter_set
:1;
197 bool cpu_sched_set
:1;
198 bool mount_apivfs_set
:1;
200 /* This is not exposed to the user but available internally. We need it to make sure that whenever we
201 * spawn /usr/bin/mount it is run in the same process group as us so that the autofs logic detects
202 * that it belongs to us and we don't enter a trigger loop. */
205 bool cpu_sched_reset_on_fork
;
209 int oom_score_adjust
;
212 int cpu_sched_policy
;
213 int cpu_sched_priority
;
214 uint64_t coredump_filter
;
217 NUMAPolicy numa_policy
;
218 bool cpu_affinity_from_numa
;
221 ExecOutput std_output
;
222 ExecOutput std_error
;
224 char *stdio_fdname
[3];
228 size_t stdin_data_size
;
230 nsec_t timer_slack_nsec
;
236 bool tty_vt_disallocate
;
243 ExecKeyringMode keyring_mode
;
245 /* Since resolving these names might involve socket
246 * connections and we don't want to deadlock ourselves these
247 * names are resolved on execution only and in the child
251 char **supplementary_groups
;
256 ExecUtmpMode utmp_mode
;
258 bool no_new_privileges
;
260 bool selinux_context_ignore
;
261 bool apparmor_profile_ignore
;
262 bool smack_process_label_ignore
;
264 char *selinux_context
;
265 char *apparmor_profile
;
266 char *smack_process_label
;
268 char **read_write_paths
, **read_only_paths
, **inaccessible_paths
, **exec_paths
, **no_exec_paths
;
269 char **exec_search_path
;
270 unsigned long mount_flags
;
271 BindMount
*bind_mounts
;
272 size_t n_bind_mounts
;
273 TemporaryFileSystem
*temporary_filesystems
;
274 size_t n_temporary_filesystems
;
275 MountImage
*mount_images
;
276 size_t n_mount_images
;
277 MountImage
*extension_images
;
278 size_t n_extension_images
;
279 char **extension_directories
;
281 uint64_t capability_bounding_set
;
282 uint64_t capability_ambient_set
;
286 bool syslog_level_prefix
;
287 char *syslog_identifier
;
289 struct iovec
* log_extra_fields
;
290 size_t n_log_extra_fields
;
291 Set
*log_filter_allowed_patterns
;
292 Set
*log_filter_denied_patterns
;
294 usec_t log_ratelimit_interval_usec
;
295 unsigned log_ratelimit_burst
;
301 ProtectProc protect_proc
; /* hidepid= */
302 ProcSubset proc_subset
; /* subset= */
305 bool private_network
;
306 bool private_devices
;
310 bool protect_kernel_tunables
;
311 bool protect_kernel_modules
;
312 bool protect_kernel_logs
;
314 bool protect_control_groups
;
315 ProtectSystem protect_system
;
316 ProtectHome protect_home
;
317 bool protect_hostname
;
323 bool memory_deny_write_execute
;
324 bool restrict_realtime
;
325 bool restrict_suid_sgid
;
327 bool lock_personality
;
328 unsigned long personality
;
330 unsigned long restrict_namespaces
; /* The CLONE_NEWxyz flags permitted to the unit's processes */
332 Set
*restrict_filesystems
;
333 bool restrict_filesystems_allow_list
:1;
335 Hashmap
*syscall_filter
;
338 bool syscall_allow_list
:1;
340 Hashmap
*syscall_log
;
341 bool syscall_log_allow_list
:1; /* Log listed system calls */
343 bool address_families_allow_list
:1;
344 Set
*address_families
;
346 char *network_namespace_path
;
347 char *ipc_namespace_path
;
349 ExecDirectory directories
[_EXEC_DIRECTORY_TYPE_MAX
];
350 ExecPreserveMode runtime_directory_preserve_mode
;
351 usec_t timeout_clean_usec
;
353 Hashmap
*set_credentials
; /* output id → ExecSetCredential */
354 Hashmap
*load_credentials
; /* output id → ExecLoadCredential */
357 static inline bool exec_context_restrict_namespaces_set(const ExecContext
*c
) {
360 return (c
->restrict_namespaces
& NAMESPACE_FLAGS_ALL
) != NAMESPACE_FLAGS_ALL
;
363 static inline bool exec_context_restrict_filesystems_set(const ExecContext
*c
) {
366 return c
->restrict_filesystems_allow_list
||
367 !set_isempty(c
->restrict_filesystems
);
370 static inline bool exec_context_with_rootfs(const ExecContext
*c
) {
373 /* Checks if RootDirectory= or RootImage= are used */
375 return !empty_or_root(c
->root_directory
) || c
->root_image
;
378 typedef enum ExecFlags
{
379 EXEC_APPLY_SANDBOXING
= 1 << 0,
380 EXEC_APPLY_CHROOT
= 1 << 1,
381 EXEC_APPLY_TTY_STDIN
= 1 << 2,
382 EXEC_PASS_LOG_UNIT
= 1 << 3, /* Whether to pass the unit name to the service's journal stream connection */
383 EXEC_CHOWN_DIRECTORIES
= 1 << 4, /* chown() the runtime/state/cache/log directories to the user we run as, under all conditions */
384 EXEC_NSS_DYNAMIC_BYPASS
= 1 << 5, /* Set the SYSTEMD_NSS_DYNAMIC_BYPASS environment variable, to disable nss-systemd blocking on PID 1, for use by dbus-daemon */
385 EXEC_CGROUP_DELEGATE
= 1 << 6,
386 EXEC_IS_CONTROL
= 1 << 7,
387 EXEC_CONTROL_CGROUP
= 1 << 8, /* 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 */
388 EXEC_WRITE_CREDENTIALS
= 1 << 9, /* Set up the credential store logic */
390 /* The following are not used by execute.c, but by consumers internally */
391 EXEC_PASS_FDS
= 1 << 10,
392 EXEC_SETENV_RESULT
= 1 << 11,
393 EXEC_SET_WATCHDOG
= 1 << 12,
394 EXEC_SETENV_MONITOR_RESULT
= 1 << 13, /* Pass exit status to OnFailure= and OnSuccess= dependencies. */
397 /* Parameters for a specific invocation of a command. This structure is put together right before a command is
399 struct ExecParameters
{
405 size_t n_storage_fds
;
408 bool selinux_context_net
:1;
410 CGroupMask cgroup_supported
;
411 const char *cgroup_path
;
414 const char *received_credentials_directory
;
415 const char *received_encrypted_credentials_directory
;
417 const char *confirm_spawn
;
419 usec_t watchdog_usec
;
427 /* An fd that is closed by the execve(), and thus will result in EOF when the execve() is done */
430 const char *notify_socket
;
432 LIST_HEAD(OpenFile
, open_files
);
436 #include "dynamic-user.h"
438 int exec_spawn(Unit
*unit
,
439 ExecCommand
*command
,
440 const ExecContext
*context
,
441 const ExecParameters
*exec_params
,
442 ExecRuntime
*runtime
,
443 DynamicCreds
*dynamic_creds
,
446 void exec_command_done_array(ExecCommand
*c
, size_t n
);
447 ExecCommand
* exec_command_free_list(ExecCommand
*c
);
448 void exec_command_free_array(ExecCommand
**c
, size_t n
);
449 void exec_command_reset_status_array(ExecCommand
*c
, size_t n
);
450 void exec_command_reset_status_list_array(ExecCommand
**c
, size_t n
);
451 void exec_command_dump_list(ExecCommand
*c
, FILE *f
, const char *prefix
);
452 void exec_command_append_list(ExecCommand
**l
, ExecCommand
*e
);
453 int exec_command_set(ExecCommand
*c
, const char *path
, ...) _sentinel_
;
454 int exec_command_append(ExecCommand
*c
, const char *path
, ...) _sentinel_
;
456 void exec_context_init(ExecContext
*c
);
457 void exec_context_done(ExecContext
*c
);
458 void exec_context_dump(const ExecContext
*c
, FILE* f
, const char *prefix
);
460 int exec_context_destroy_runtime_directory(const ExecContext
*c
, const char *runtime_root
);
461 int exec_context_destroy_credentials(const ExecContext
*c
, const char *runtime_root
, const char *unit
);
462 int exec_context_destroy_mount_ns_dir(Unit
*u
);
464 const char* exec_context_fdname(const ExecContext
*c
, int fd_index
);
466 bool exec_context_may_touch_console(const ExecContext
*c
);
467 bool exec_context_maintains_privileges(const ExecContext
*c
);
469 int exec_context_get_effective_ioprio(const ExecContext
*c
);
470 bool exec_context_get_effective_mount_apivfs(const ExecContext
*c
);
472 void exec_context_free_log_extra_fields(ExecContext
*c
);
474 void exec_context_revert_tty(ExecContext
*c
);
476 int exec_context_get_clean_directories(ExecContext
*c
, char **prefix
, ExecCleanMask mask
, char ***ret
);
477 int exec_context_get_clean_mask(ExecContext
*c
, ExecCleanMask
*ret
);
479 void exec_status_start(ExecStatus
*s
, pid_t pid
);
480 void exec_status_exit(ExecStatus
*s
, const ExecContext
*context
, pid_t pid
, int code
, int status
);
481 void exec_status_dump(const ExecStatus
*s
, FILE *f
, const char *prefix
);
482 void exec_status_reset(ExecStatus
*s
);
484 int exec_runtime_acquire(Manager
*m
, const ExecContext
*c
, const char *name
, bool create
, ExecRuntime
**ret
);
485 ExecRuntime
*exec_runtime_unref(ExecRuntime
*r
, bool destroy
);
487 int exec_runtime_serialize(const Manager
*m
, FILE *f
, FDSet
*fds
);
488 int exec_runtime_deserialize_compat(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
);
489 int exec_runtime_deserialize_one(Manager
*m
, const char *value
, FDSet
*fds
);
490 void exec_runtime_vacuum(Manager
*m
);
492 void exec_params_clear(ExecParameters
*p
);
494 bool exec_context_get_cpu_affinity_from_numa(const ExecContext
*c
);
496 ExecSetCredential
*exec_set_credential_free(ExecSetCredential
*sc
);
497 DEFINE_TRIVIAL_CLEANUP_FUNC(ExecSetCredential
*, exec_set_credential_free
);
499 ExecLoadCredential
*exec_load_credential_free(ExecLoadCredential
*lc
);
500 DEFINE_TRIVIAL_CLEANUP_FUNC(ExecLoadCredential
*, exec_load_credential_free
);
502 void exec_directory_done(ExecDirectory
*d
);
503 int exec_directory_add(ExecDirectory
*d
, const char *path
, const char *symlink
);
504 void exec_directory_sort(ExecDirectory
*d
);
506 extern const struct hash_ops exec_set_credential_hash_ops
;
507 extern const struct hash_ops exec_load_credential_hash_ops
;
509 const char* exec_output_to_string(ExecOutput i
) _const_
;
510 ExecOutput
exec_output_from_string(const char *s
) _pure_
;
512 const char* exec_input_to_string(ExecInput i
) _const_
;
513 ExecInput
exec_input_from_string(const char *s
) _pure_
;
515 const char* exec_utmp_mode_to_string(ExecUtmpMode i
) _const_
;
516 ExecUtmpMode
exec_utmp_mode_from_string(const char *s
) _pure_
;
518 const char* exec_preserve_mode_to_string(ExecPreserveMode i
) _const_
;
519 ExecPreserveMode
exec_preserve_mode_from_string(const char *s
) _pure_
;
521 const char* exec_keyring_mode_to_string(ExecKeyringMode i
) _const_
;
522 ExecKeyringMode
exec_keyring_mode_from_string(const char *s
) _pure_
;
524 const char* exec_directory_type_to_string(ExecDirectoryType i
) _const_
;
525 ExecDirectoryType
exec_directory_type_from_string(const char *s
) _pure_
;
527 const char* exec_directory_type_symlink_to_string(ExecDirectoryType i
) _const_
;
528 ExecDirectoryType
exec_directory_type_symlink_from_string(const char *s
) _pure_
;
530 const char* exec_resource_type_to_string(ExecDirectoryType i
) _const_
;
531 ExecDirectoryType
exec_resource_type_from_string(const char *s
) _pure_
;
533 bool exec_needs_mount_namespace(const ExecContext
*context
, const ExecParameters
*params
, const ExecRuntime
*runtime
);