src/core/execute.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   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;
  10
  11 #include <sched.h>
  12 #include <stdbool.h>
  13 #include <stdio.h>
  14 #include <sys/capability.h>
  15
  16 #include "cgroup-util.h"
  17 #include "coredump-util.h"
  18 #include "cpu-set-util.h"
  19 #include "exec-util.h"
  20 #include "fdset.h"
  21 #include "list.h"
  22 #include "missing_resource.h"
  23 #include "namespace.h"
  24 #include "nsflags.h"
  25 #include "numa-util.h"
  26 #include "time-util.h"
  27
  28 #define EXEC_STDIN_DATA_MAX (64U*1024U*1024U)
  29
  30 typedef enum ExecUtmpMode {
  31         EXEC_UTMP_INIT,
  32         EXEC_UTMP_LOGIN,
  33         EXEC_UTMP_USER,
  34         _EXEC_UTMP_MODE_MAX,
  35         _EXEC_UTMP_MODE_INVALID = -1
  36 } ExecUtmpMode;
  37
  38 typedef enum ExecInput {
  39         EXEC_INPUT_NULL,
  40         EXEC_INPUT_TTY,
  41         EXEC_INPUT_TTY_FORCE,
  42         EXEC_INPUT_TTY_FAIL,
  43         EXEC_INPUT_SOCKET,
  44         EXEC_INPUT_NAMED_FD,
  45         EXEC_INPUT_DATA,
  46         EXEC_INPUT_FILE,
  47         _EXEC_INPUT_MAX,
  48         _EXEC_INPUT_INVALID = -1
  49 } ExecInput;
  50
  51 typedef enum ExecOutput {
  52         EXEC_OUTPUT_INHERIT,
  53         EXEC_OUTPUT_NULL,
  54         EXEC_OUTPUT_TTY,
  55         EXEC_OUTPUT_KMSG,
  56         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  57         EXEC_OUTPUT_JOURNAL,
  58         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  59         EXEC_OUTPUT_SOCKET,
  60         EXEC_OUTPUT_NAMED_FD,
  61         EXEC_OUTPUT_FILE,
  62         EXEC_OUTPUT_FILE_APPEND,
  63         _EXEC_OUTPUT_MAX,
  64         _EXEC_OUTPUT_INVALID = -1
  65 } ExecOutput;
  66
  67 typedef enum ExecPreserveMode {
  68         EXEC_PRESERVE_NO,
  69         EXEC_PRESERVE_YES,
  70         EXEC_PRESERVE_RESTART,
  71         _EXEC_PRESERVE_MODE_MAX,
  72         _EXEC_PRESERVE_MODE_INVALID = -1
  73 } ExecPreserveMode;
  74
  75 typedef enum ExecKeyringMode {
  76         EXEC_KEYRING_INHERIT,
  77         EXEC_KEYRING_PRIVATE,
  78         EXEC_KEYRING_SHARED,
  79         _EXEC_KEYRING_MODE_MAX,
  80         _EXEC_KEYRING_MODE_INVALID = -1,
  81 } ExecKeyringMode;
  82
  83 /* Contains start and exit information about an executed command.  */
  84 struct ExecStatus {
  85         dual_timestamp start_timestamp;
  86         dual_timestamp exit_timestamp;
  87         pid_t pid;
  88         int code;     /* as in siginfo_t::si_code */
  89         int status;   /* as in sigingo_t::si_status */
  90 };
  91
  92 /* Stores information about commands we execute. Covers both configuration settings as well as runtime data. */
  93 struct ExecCommand {
  94         char *path;
  95         char **argv;
  96         ExecStatus exec_status;
  97         ExecCommandFlags flags;
  98         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  99 };
 100
 101 /* Encapsulates certain aspects of the runtime environment that is to be shared between multiple otherwise separate
 102  * invocations of commands. Specifically, this allows sharing of /tmp and /var/tmp data as well as network namespaces
 103  * between invocations of commands. This is a reference counted object, with one reference taken by each currently
 104  * active command invocation that wants to share this runtime. */
 105 struct ExecRuntime {
 106         unsigned n_ref;
 107
 108         Manager *manager;
 109
 110         char *id; /* Unit id of the owner */
 111
 112         char *tmp_dir;
 113         char *var_tmp_dir;
 114
 115         /* An AF_UNIX socket pair, that contains a datagram containing a file descriptor referring to the network
 116          * namespace. */
 117         int netns_storage_socket[2];
 118 };
 119
 120 typedef enum ExecDirectoryType {
 121         EXEC_DIRECTORY_RUNTIME = 0,
 122         EXEC_DIRECTORY_STATE,
 123         EXEC_DIRECTORY_CACHE,
 124         EXEC_DIRECTORY_LOGS,
 125         EXEC_DIRECTORY_CONFIGURATION,
 126         _EXEC_DIRECTORY_TYPE_MAX,
 127         _EXEC_DIRECTORY_TYPE_INVALID = -1,
 128 } ExecDirectoryType;
 129
 130 typedef struct ExecDirectory {
 131         char **paths;
 132         mode_t mode;
 133 } ExecDirectory;
 134
 135 typedef enum ExecCleanMask {
 136         /* In case you wonder why the bitmask below doesn't use "directory" in its name: we want to keep this
 137          * generic so that .timer timestamp files can nicely be covered by this too, and similar. */
 138         EXEC_CLEAN_RUNTIME       = 1U << EXEC_DIRECTORY_RUNTIME,
 139         EXEC_CLEAN_STATE         = 1U << EXEC_DIRECTORY_STATE,
 140         EXEC_CLEAN_CACHE         = 1U << EXEC_DIRECTORY_CACHE,
 141         EXEC_CLEAN_LOGS          = 1U << EXEC_DIRECTORY_LOGS,
 142         EXEC_CLEAN_CONFIGURATION = 1U << EXEC_DIRECTORY_CONFIGURATION,
 143         EXEC_CLEAN_NONE          = 0,
 144         EXEC_CLEAN_ALL           = (1U << _EXEC_DIRECTORY_TYPE_MAX) - 1,
 145         _EXEC_CLEAN_MASK_INVALID = -1,
 146 } ExecCleanMask;
 147
 148 /* Encodes configuration parameters applied to invoked commands. Does not carry runtime data, but only configuration
 149  * changes sourced from unit files and suchlike. ExecContext objects are usually embedded into Unit objects, and do not
 150  * change after being loaded. */
 151 struct ExecContext {
 152         char **environment;
 153         char **environment_files;
 154         char **pass_environment;
 155         char **unset_environment;
 156
 157         struct rlimit *rlimit[_RLIMIT_MAX];
 158         char *working_directory, *root_directory, *root_image, *root_verity, *root_hash_path, *root_hash_sig_path;
 159         void *root_hash, *root_hash_sig;
 160         size_t root_hash_size, root_hash_sig_size;
 161         bool working_directory_missing_ok:1;
 162         bool working_directory_home:1;
 163
 164         bool oom_score_adjust_set:1;
 165         bool coredump_filter_set:1;
 166         bool nice_set:1;
 167         bool ioprio_set:1;
 168         bool cpu_sched_set:1;
 169
 170         /* This is not exposed to the user but available internally. We need it to make sure that whenever we
 171          * spawn /usr/bin/mount it is run in the same process group as us so that the autofs logic detects
 172          * that it belongs to us and we don't enter a trigger loop. */
 173         bool same_pgrp;
 174
 175         bool cpu_sched_reset_on_fork;
 176         bool non_blocking;
 177
 178         mode_t umask;
 179         int oom_score_adjust;
 180         int nice;
 181         int ioprio;
 182         int cpu_sched_policy;
 183         int cpu_sched_priority;
 184         uint64_t coredump_filter;
 185
 186         CPUSet cpu_set;
 187         NUMAPolicy numa_policy;
 188         bool cpu_affinity_from_numa;
 189
 190         ExecInput std_input;
 191         ExecOutput std_output;
 192         ExecOutput std_error;
 193         bool stdio_as_fds;
 194         char *stdio_fdname[3];
 195         char *stdio_file[3];
 196
 197         void *stdin_data;
 198         size_t stdin_data_size;
 199
 200         nsec_t timer_slack_nsec;
 201
 202         char *tty_path;
 203
 204         bool tty_reset;
 205         bool tty_vhangup;
 206         bool tty_vt_disallocate;
 207
 208         bool ignore_sigpipe;
 209
 210         ExecKeyringMode keyring_mode;
 211
 212         /* Since resolving these names might involve socket
 213          * connections and we don't want to deadlock ourselves these
 214          * names are resolved on execution only and in the child
 215          * process. */
 216         char *user;
 217         char *group;
 218         char **supplementary_groups;
 219
 220         char *pam_name;
 221
 222         char *utmp_id;
 223         ExecUtmpMode utmp_mode;
 224
 225         bool no_new_privileges;
 226
 227         bool selinux_context_ignore;
 228         bool apparmor_profile_ignore;
 229         bool smack_process_label_ignore;
 230
 231         char *selinux_context;
 232         char *apparmor_profile;
 233         char *smack_process_label;
 234
 235         char **read_write_paths, **read_only_paths, **inaccessible_paths;
 236         unsigned long mount_flags;
 237         BindMount *bind_mounts;
 238         size_t n_bind_mounts;
 239         TemporaryFileSystem *temporary_filesystems;
 240         size_t n_temporary_filesystems;
 241
 242         uint64_t capability_bounding_set;
 243         uint64_t capability_ambient_set;
 244         int secure_bits;
 245
 246         int syslog_priority;
 247         bool syslog_level_prefix;
 248         char *syslog_identifier;
 249
 250         struct iovec* log_extra_fields;
 251         size_t n_log_extra_fields;
 252
 253         usec_t log_ratelimit_interval_usec;
 254         unsigned log_ratelimit_burst;
 255
 256         int log_level_max;
 257
 258         char *log_namespace;
 259
 260         bool private_tmp;
 261         bool private_network;
 262         bool private_devices;
 263         bool private_users;
 264         bool private_mounts;
 265         bool protect_kernel_tunables;
 266         bool protect_kernel_modules;
 267         bool protect_kernel_logs;
 268         bool protect_clock;
 269         bool protect_control_groups;
 270         ProtectSystem protect_system;
 271         ProtectHome protect_home;
 272         bool protect_hostname;
 273         bool mount_apivfs;
 274
 275         bool dynamic_user;
 276         bool remove_ipc;
 277
 278         bool memory_deny_write_execute;
 279         bool restrict_realtime;
 280         bool restrict_suid_sgid;
 281
 282         bool lock_personality;
 283         unsigned long personality;
 284
 285         unsigned long restrict_namespaces; /* The CLONE_NEWxyz flags permitted to the unit's processes */
 286
 287         Hashmap *syscall_filter;
 288         Set *syscall_archs;
 289         int syscall_errno;
 290         bool syscall_allow_list:1;
 291
 292         bool address_families_allow_list:1;
 293         Set *address_families;
 294
 295         char *network_namespace_path;
 296
 297         ExecDirectory directories[_EXEC_DIRECTORY_TYPE_MAX];
 298         ExecPreserveMode runtime_directory_preserve_mode;
 299         usec_t timeout_clean_usec;
 300 };
 301
 302 static inline bool exec_context_restrict_namespaces_set(const ExecContext *c) {
 303         assert(c);
 304
 305         return (c->restrict_namespaces & NAMESPACE_FLAGS_ALL) != NAMESPACE_FLAGS_ALL;
 306 }
 307
 308 typedef enum ExecFlags {
 309         EXEC_APPLY_SANDBOXING  = 1 << 0,
 310         EXEC_APPLY_CHROOT      = 1 << 1,
 311         EXEC_APPLY_TTY_STDIN   = 1 << 2,
 312         EXEC_PASS_LOG_UNIT     = 1 << 3, /* Whether to pass the unit name to the service's journal stream connection */
 313         EXEC_CHOWN_DIRECTORIES = 1 << 4, /* chown() the runtime/state/cache/log directories to the user we run as, under all conditions */
 314         EXEC_NSS_BYPASS_BUS    = 1 << 5, /* Set the SYSTEMD_NSS_BYPASS_BUS environment variable, to disable nss-systemd for dbus */
 315         EXEC_CGROUP_DELEGATE   = 1 << 6,
 316         EXEC_IS_CONTROL        = 1 << 7,
 317         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 */
 318
 319         /* The following are not used by execute.c, but by consumers internally */
 320         EXEC_PASS_FDS          = 1 << 9,
 321         EXEC_SETENV_RESULT     = 1 << 10,
 322         EXEC_SET_WATCHDOG      = 1 << 11,
 323 } ExecFlags;
 324
 325 /* Parameters for a specific invocation of a command. This structure is put together right before a command is
 326  * executed. */
 327 struct ExecParameters {
 328         char **environment;
 329
 330         int *fds;
 331         char **fd_names;
 332         size_t n_socket_fds;
 333         size_t n_storage_fds;
 334
 335         ExecFlags flags;
 336         bool selinux_context_net:1;
 337
 338         CGroupMask cgroup_supported;
 339         const char *cgroup_path;
 340
 341         char **prefix;
 342
 343         const char *confirm_spawn;
 344
 345         usec_t watchdog_usec;
 346
 347         int *idle_pipe;
 348
 349         int stdin_fd;
 350         int stdout_fd;
 351         int stderr_fd;
 352
 353         /* An fd that is closed by the execve(), and thus will result in EOF when the execve() is done */
 354         int exec_fd;
 355 };
 356
 357 #include "unit.h"
 358 #include "dynamic-user.h"
 359
 360 int exec_spawn(Unit *unit,
 361                ExecCommand *command,
 362                const ExecContext *context,
 363                const ExecParameters *exec_params,
 364                ExecRuntime *runtime,
 365                DynamicCreds *dynamic_creds,
 366                pid_t *ret);
 367
 368 void exec_command_done_array(ExecCommand *c, size_t n);
 369 ExecCommand* exec_command_free_list(ExecCommand *c);
 370 void exec_command_free_array(ExecCommand **c, size_t n);
 371 void exec_command_reset_status_array(ExecCommand *c, size_t n);
 372 void exec_command_reset_status_list_array(ExecCommand **c, size_t n);
 373 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 374 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 375 int exec_command_set(ExecCommand *c, const char *path, ...) _sentinel_;
 376 int exec_command_append(ExecCommand *c, const char *path, ...) _sentinel_;
 377
 378 void exec_context_init(ExecContext *c);
 379 void exec_context_done(ExecContext *c);
 380 void exec_context_dump(const ExecContext *c, FILE* f, const char *prefix);
 381
 382 int exec_context_destroy_runtime_directory(const ExecContext *c, const char *runtime_root);
 383
 384 const char* exec_context_fdname(const ExecContext *c, int fd_index);
 385
 386 bool exec_context_may_touch_console(const ExecContext *c);
 387 bool exec_context_maintains_privileges(const ExecContext *c);
 388
 389 int exec_context_get_effective_ioprio(const ExecContext *c);
 390
 391 void exec_context_free_log_extra_fields(ExecContext *c);
 392
 393 void exec_context_revert_tty(ExecContext *c);
 394
 395 int exec_context_get_clean_directories(ExecContext *c, char **prefix, ExecCleanMask mask, char ***ret);
 396 int exec_context_get_clean_mask(ExecContext *c, ExecCleanMask *ret);
 397
 398 void exec_status_start(ExecStatus *s, pid_t pid);
 399 void exec_status_exit(ExecStatus *s, const ExecContext *context, pid_t pid, int code, int status);
 400 void exec_status_dump(const ExecStatus *s, FILE *f, const char *prefix);
 401 void exec_status_reset(ExecStatus *s);
 402
 403 int exec_runtime_acquire(Manager *m, const ExecContext *c, const char *name, bool create, ExecRuntime **ret);
 404 ExecRuntime *exec_runtime_unref(ExecRuntime *r, bool destroy);
 405
 406 int exec_runtime_serialize(const Manager *m, FILE *f, FDSet *fds);
 407 int exec_runtime_deserialize_compat(Unit *u, const char *key, const char *value, FDSet *fds);
 408 void exec_runtime_deserialize_one(Manager *m, const char *value, FDSet *fds);
 409 void exec_runtime_vacuum(Manager *m);
 410
 411 void exec_params_clear(ExecParameters *p);
 412
 413 bool exec_context_get_cpu_affinity_from_numa(const ExecContext *c);
 414
 415 const char* exec_output_to_string(ExecOutput i) _const_;
 416 ExecOutput exec_output_from_string(const char *s) _pure_;
 417
 418 const char* exec_input_to_string(ExecInput i) _const_;
 419 ExecInput exec_input_from_string(const char *s) _pure_;
 420
 421 const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_;
 422 ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_;
 423
 424 const char* exec_preserve_mode_to_string(ExecPreserveMode i) _const_;
 425 ExecPreserveMode exec_preserve_mode_from_string(const char *s) _pure_;
 426
 427 const char* exec_keyring_mode_to_string(ExecKeyringMode i) _const_;
 428 ExecKeyringMode exec_keyring_mode_from_string(const char *s) _pure_;
 429
 430 const char* exec_directory_type_to_string(ExecDirectoryType i) _const_;
 431 ExecDirectoryType exec_directory_type_from_string(const char *s) _pure_;
 432
 433 const char* exec_resource_type_to_string(ExecDirectoryType i) _const_;
 434 ExecDirectoryType exec_resource_type_from_string(const char *s) _pure_;