src/core/execute.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 typedef struct ExecStatus ExecStatus;
  23 typedef struct ExecCommand ExecCommand;
  24 typedef struct ExecContext ExecContext;
  25 typedef struct ExecRuntime ExecRuntime;
  26 typedef struct ExecParameters ExecParameters;
  27
  28 #include <sched.h>
  29 #include <stdbool.h>
  30 #include <stdio.h>
  31 #include <sys/capability.h>
  32
  33 #include "cgroup-util.h"
  34 #include "fdset.h"
  35 #include "list.h"
  36 #include "missing.h"
  37 #include "namespace.h"
  38
  39 typedef enum ExecUtmpMode {
  40         EXEC_UTMP_INIT,
  41         EXEC_UTMP_LOGIN,
  42         EXEC_UTMP_USER,
  43         _EXEC_UTMP_MODE_MAX,
  44         _EXEC_UTMP_MODE_INVALID = -1
  45 } ExecUtmpMode;
  46
  47 typedef enum ExecInput {
  48         EXEC_INPUT_NULL,
  49         EXEC_INPUT_TTY,
  50         EXEC_INPUT_TTY_FORCE,
  51         EXEC_INPUT_TTY_FAIL,
  52         EXEC_INPUT_SOCKET,
  53         EXEC_INPUT_NAMED_FD,
  54         _EXEC_INPUT_MAX,
  55         _EXEC_INPUT_INVALID = -1
  56 } ExecInput;
  57
  58 typedef enum ExecOutput {
  59         EXEC_OUTPUT_INHERIT,
  60         EXEC_OUTPUT_NULL,
  61         EXEC_OUTPUT_TTY,
  62         EXEC_OUTPUT_SYSLOG,
  63         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  64         EXEC_OUTPUT_KMSG,
  65         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  66         EXEC_OUTPUT_JOURNAL,
  67         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  68         EXEC_OUTPUT_SOCKET,
  69         EXEC_OUTPUT_NAMED_FD,
  70         _EXEC_OUTPUT_MAX,
  71         _EXEC_OUTPUT_INVALID = -1
  72 } ExecOutput;
  73
  74 struct ExecStatus {
  75         dual_timestamp start_timestamp;
  76         dual_timestamp exit_timestamp;
  77         pid_t pid;
  78         int code;     /* as in siginfo_t::si_code */
  79         int status;   /* as in sigingo_t::si_status */
  80 };
  81
  82 struct ExecCommand {
  83         char *path;
  84         char **argv;
  85         ExecStatus exec_status;
  86         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  87         bool ignore:1;
  88         bool privileged:1;
  89 };
  90
  91 struct ExecRuntime {
  92         int n_ref;
  93
  94         char *tmp_dir;
  95         char *var_tmp_dir;
  96
  97         /* An AF_UNIX socket pair, that contains a datagram containing a file descriptor referring to the network
  98          * namespace. */
  99         int netns_storage_socket[2];
 100 };
 101
 102 struct ExecContext {
 103         char **environment;
 104         char **environment_files;
 105         char **pass_environment;
 106
 107         struct rlimit *rlimit[_RLIMIT_MAX];
 108         char *working_directory, *root_directory;
 109         bool working_directory_missing_ok;
 110         bool working_directory_home;
 111
 112         mode_t umask;
 113         int oom_score_adjust;
 114         int nice;
 115         int ioprio;
 116         int cpu_sched_policy;
 117         int cpu_sched_priority;
 118
 119         cpu_set_t *cpuset;
 120         unsigned cpuset_ncpus;
 121
 122         ExecInput std_input;
 123         ExecOutput std_output;
 124         ExecOutput std_error;
 125         char *stdio_fdname[3];
 126
 127         nsec_t timer_slack_nsec;
 128
 129         bool stdio_as_fds;
 130
 131         char *tty_path;
 132
 133         bool tty_reset;
 134         bool tty_vhangup;
 135         bool tty_vt_disallocate;
 136
 137         bool ignore_sigpipe;
 138
 139         /* Since resolving these names might involve socket
 140          * connections and we don't want to deadlock ourselves these
 141          * names are resolved on execution only and in the child
 142          * process. */
 143         char *user;
 144         char *group;
 145         char **supplementary_groups;
 146
 147         char *pam_name;
 148
 149         char *utmp_id;
 150         ExecUtmpMode utmp_mode;
 151
 152         bool selinux_context_ignore;
 153         char *selinux_context;
 154
 155         bool apparmor_profile_ignore;
 156         char *apparmor_profile;
 157
 158         bool smack_process_label_ignore;
 159         char *smack_process_label;
 160
 161         char **read_write_paths, **read_only_paths, **inaccessible_paths;
 162         unsigned long mount_flags;
 163
 164         uint64_t capability_bounding_set;
 165         uint64_t capability_ambient_set;
 166         int secure_bits;
 167
 168         int syslog_priority;
 169         char *syslog_identifier;
 170         bool syslog_level_prefix;
 171
 172         bool cpu_sched_reset_on_fork;
 173         bool non_blocking;
 174         bool private_tmp;
 175         bool private_network;
 176         bool private_devices;
 177         bool private_users;
 178         ProtectSystem protect_system;
 179         ProtectHome protect_home;
 180         bool protect_kernel_tunables;
 181         bool protect_kernel_modules;
 182         bool protect_control_groups;
 183
 184         bool no_new_privileges;
 185
 186         bool dynamic_user;
 187         bool remove_ipc;
 188
 189         /* This is not exposed to the user but available
 190          * internally. We need it to make sure that whenever we spawn
 191          * /usr/bin/mount it is run in the same process group as us so
 192          * that the autofs logic detects that it belongs to us and we
 193          * don't enter a trigger loop. */
 194         bool same_pgrp;
 195
 196         unsigned long personality;
 197
 198         Set *syscall_filter;
 199         Set *syscall_archs;
 200         int syscall_errno;
 201         bool syscall_whitelist:1;
 202
 203         Set *address_families;
 204         bool address_families_whitelist:1;
 205
 206         char **runtime_directory;
 207         mode_t runtime_directory_mode;
 208
 209         bool memory_deny_write_execute;
 210         bool restrict_realtime;
 211
 212         bool oom_score_adjust_set:1;
 213         bool nice_set:1;
 214         bool ioprio_set:1;
 215         bool cpu_sched_set:1;
 216         bool no_new_privileges_set:1;
 217 };
 218
 219 typedef enum ExecFlags {
 220         EXEC_CONFIRM_SPAWN     = 1U << 0,
 221         EXEC_APPLY_PERMISSIONS = 1U << 1,
 222         EXEC_APPLY_CHROOT      = 1U << 2,
 223         EXEC_APPLY_TTY_STDIN   = 1U << 3,
 224
 225         /* The following are not used by execute.c, but by consumers internally */
 226         EXEC_PASS_FDS          = 1U << 4,
 227         EXEC_IS_CONTROL        = 1U << 5,
 228         EXEC_SETENV_RESULT     = 1U << 6,
 229         EXEC_SET_WATCHDOG      = 1U << 7,
 230 } ExecFlags;
 231
 232 struct ExecParameters {
 233         char **argv;
 234         char **environment;
 235
 236         int *fds;
 237         char **fd_names;
 238         unsigned n_fds;
 239
 240         ExecFlags flags;
 241         bool selinux_context_net:1;
 242
 243         bool cgroup_delegate:1;
 244         CGroupMask cgroup_supported;
 245         const char *cgroup_path;
 246
 247         const char *runtime_prefix;
 248
 249         usec_t watchdog_usec;
 250
 251         int *idle_pipe;
 252
 253         int stdin_fd;
 254         int stdout_fd;
 255         int stderr_fd;
 256 };
 257
 258 #include "unit.h"
 259 #include "dynamic-user.h"
 260
 261 int exec_spawn(Unit *unit,
 262                ExecCommand *command,
 263                const ExecContext *context,
 264                const ExecParameters *exec_params,
 265                ExecRuntime *runtime,
 266                DynamicCreds *dynamic_creds,
 267                pid_t *ret);
 268
 269 void exec_command_done(ExecCommand *c);
 270 void exec_command_done_array(ExecCommand *c, unsigned n);
 271
 272 ExecCommand* exec_command_free_list(ExecCommand *c);
 273 void exec_command_free_array(ExecCommand **c, unsigned n);
 274
 275 char *exec_command_line(char **argv);
 276
 277 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 278 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 279 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 280 int exec_command_set(ExecCommand *c, const char *path, ...);
 281 int exec_command_append(ExecCommand *c, const char *path, ...);
 282
 283 void exec_context_init(ExecContext *c);
 284 void exec_context_done(ExecContext *c);
 285 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 286
 287 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 288
 289 int exec_context_load_environment(Unit *unit, const ExecContext *c, char ***l);
 290 int exec_context_named_iofds(Unit *unit, const ExecContext *c, const ExecParameters *p, int named_iofds[3]);
 291 const char* exec_context_fdname(const ExecContext *c, int fd_index);
 292
 293 bool exec_context_may_touch_console(ExecContext *c);
 294 bool exec_context_maintains_privileges(ExecContext *c);
 295
 296 void exec_status_start(ExecStatus *s, pid_t pid);
 297 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 298 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 299
 300 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 301 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 302 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 303
 304 int exec_runtime_serialize(Unit *unit, ExecRuntime *rt, FILE *f, FDSet *fds);
 305 int exec_runtime_deserialize_item(Unit *unit, ExecRuntime **rt, const char *key, const char *value, FDSet *fds);
 306
 307 void exec_runtime_destroy(ExecRuntime *rt);
 308
 309 const char* exec_output_to_string(ExecOutput i) _const_;
 310 ExecOutput exec_output_from_string(const char *s) _pure_;
 311
 312 const char* exec_input_to_string(ExecInput i) _const_;
 313 ExecInput exec_input_from_string(const char *s) _pure_;
 314
 315 const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_;
 316 ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_;