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_MAX,
  54         _EXEC_INPUT_INVALID = -1
  55 } ExecInput;
  56
  57 typedef enum ExecOutput {
  58         EXEC_OUTPUT_INHERIT,
  59         EXEC_OUTPUT_NULL,
  60         EXEC_OUTPUT_TTY,
  61         EXEC_OUTPUT_SYSLOG,
  62         EXEC_OUTPUT_SYSLOG_AND_CONSOLE,
  63         EXEC_OUTPUT_KMSG,
  64         EXEC_OUTPUT_KMSG_AND_CONSOLE,
  65         EXEC_OUTPUT_JOURNAL,
  66         EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
  67         EXEC_OUTPUT_SOCKET,
  68         _EXEC_OUTPUT_MAX,
  69         _EXEC_OUTPUT_INVALID = -1
  70 } ExecOutput;
  71
  72 struct ExecStatus {
  73         dual_timestamp start_timestamp;
  74         dual_timestamp exit_timestamp;
  75         pid_t pid;
  76         int code;     /* as in siginfo_t::si_code */
  77         int status;   /* as in sigingo_t::si_status */
  78 };
  79
  80 struct ExecCommand {
  81         char *path;
  82         char **argv;
  83         ExecStatus exec_status;
  84         LIST_FIELDS(ExecCommand, command); /* useful for chaining commands */
  85         bool ignore:1;
  86         bool privileged:1;
  87 };
  88
  89 struct ExecRuntime {
  90         int n_ref;
  91
  92         char *tmp_dir;
  93         char *var_tmp_dir;
  94
  95         /* An AF_UNIX socket pair, that contains a datagram containing a file descriptor referring to the network
  96          * namespace. */
  97         int netns_storage_socket[2];
  98 };
  99
 100 struct ExecContext {
 101         char **environment;
 102         char **environment_files;
 103         char **pass_environment;
 104
 105         struct rlimit *rlimit[_RLIMIT_MAX];
 106         char *working_directory, *root_directory;
 107         bool working_directory_missing_ok;
 108         bool working_directory_home;
 109
 110         mode_t umask;
 111         int oom_score_adjust;
 112         int nice;
 113         int ioprio;
 114         int cpu_sched_policy;
 115         int cpu_sched_priority;
 116
 117         cpu_set_t *cpuset;
 118         unsigned cpuset_ncpus;
 119
 120         ExecInput std_input;
 121         ExecOutput std_output;
 122         ExecOutput std_error;
 123
 124         nsec_t timer_slack_nsec;
 125
 126         bool stdio_as_fds;
 127
 128         char *tty_path;
 129
 130         bool tty_reset;
 131         bool tty_vhangup;
 132         bool tty_vt_disallocate;
 133
 134         bool ignore_sigpipe;
 135
 136         /* Since resolving these names might involve socket
 137          * connections and we don't want to deadlock ourselves these
 138          * names are resolved on execution only and in the child
 139          * process. */
 140         char *user;
 141         char *group;
 142         char **supplementary_groups;
 143
 144         char *pam_name;
 145
 146         char *utmp_id;
 147         ExecUtmpMode utmp_mode;
 148
 149         bool selinux_context_ignore;
 150         char *selinux_context;
 151
 152         bool apparmor_profile_ignore;
 153         char *apparmor_profile;
 154
 155         bool smack_process_label_ignore;
 156         char *smack_process_label;
 157
 158         char **read_write_paths, **read_only_paths, **inaccessible_paths;
 159         unsigned long mount_flags;
 160
 161         uint64_t capability_bounding_set;
 162         uint64_t capability_ambient_set;
 163         int secure_bits;
 164
 165         int syslog_priority;
 166         char *syslog_identifier;
 167         bool syslog_level_prefix;
 168
 169         bool cpu_sched_reset_on_fork;
 170         bool non_blocking;
 171         bool private_tmp;
 172         bool private_network;
 173         bool private_devices;
 174         bool private_users;
 175         ProtectSystem protect_system;
 176         ProtectHome protect_home;
 177         bool protect_kernel_tunables;
 178         bool protect_control_groups;
 179
 180         bool no_new_privileges;
 181
 182         bool dynamic_user;
 183         bool remove_ipc;
 184
 185         /* This is not exposed to the user but available
 186          * internally. We need it to make sure that whenever we spawn
 187          * /usr/bin/mount it is run in the same process group as us so
 188          * that the autofs logic detects that it belongs to us and we
 189          * don't enter a trigger loop. */
 190         bool same_pgrp;
 191
 192         unsigned long personality;
 193
 194         Set *syscall_filter;
 195         Set *syscall_archs;
 196         int syscall_errno;
 197         bool syscall_whitelist:1;
 198
 199         Set *address_families;
 200         bool address_families_whitelist:1;
 201
 202         char **runtime_directory;
 203         mode_t runtime_directory_mode;
 204
 205         bool memory_deny_write_execute;
 206         bool restrict_realtime;
 207
 208         bool oom_score_adjust_set:1;
 209         bool nice_set:1;
 210         bool ioprio_set:1;
 211         bool cpu_sched_set:1;
 212         bool no_new_privileges_set:1;
 213 };
 214
 215 typedef enum ExecFlags {
 216         EXEC_CONFIRM_SPAWN     = 1U << 0,
 217         EXEC_APPLY_PERMISSIONS = 1U << 1,
 218         EXEC_APPLY_CHROOT      = 1U << 2,
 219         EXEC_APPLY_TTY_STDIN   = 1U << 3,
 220
 221         /* The following are not used by execute.c, but by consumers internally */
 222         EXEC_PASS_FDS          = 1U << 4,
 223         EXEC_IS_CONTROL        = 1U << 5,
 224         EXEC_SETENV_RESULT     = 1U << 6,
 225         EXEC_SET_WATCHDOG      = 1U << 7,
 226 } ExecFlags;
 227
 228 struct ExecParameters {
 229         char **argv;
 230         char **environment;
 231
 232         int *fds;
 233         char **fd_names;
 234         unsigned n_fds;
 235
 236         ExecFlags flags;
 237         bool selinux_context_net:1;
 238
 239         bool cgroup_delegate:1;
 240         CGroupMask cgroup_supported;
 241         const char *cgroup_path;
 242
 243         const char *runtime_prefix;
 244
 245         usec_t watchdog_usec;
 246
 247         int *idle_pipe;
 248
 249         int stdin_fd;
 250         int stdout_fd;
 251         int stderr_fd;
 252 };
 253
 254 #include "unit.h"
 255 #include "dynamic-user.h"
 256
 257 int exec_spawn(Unit *unit,
 258                ExecCommand *command,
 259                const ExecContext *context,
 260                const ExecParameters *exec_params,
 261                ExecRuntime *runtime,
 262                DynamicCreds *dynamic_creds,
 263                pid_t *ret);
 264
 265 void exec_command_done(ExecCommand *c);
 266 void exec_command_done_array(ExecCommand *c, unsigned n);
 267
 268 ExecCommand* exec_command_free_list(ExecCommand *c);
 269 void exec_command_free_array(ExecCommand **c, unsigned n);
 270
 271 char *exec_command_line(char **argv);
 272
 273 void exec_command_dump(ExecCommand *c, FILE *f, const char *prefix);
 274 void exec_command_dump_list(ExecCommand *c, FILE *f, const char *prefix);
 275 void exec_command_append_list(ExecCommand **l, ExecCommand *e);
 276 int exec_command_set(ExecCommand *c, const char *path, ...);
 277 int exec_command_append(ExecCommand *c, const char *path, ...);
 278
 279 void exec_context_init(ExecContext *c);
 280 void exec_context_done(ExecContext *c);
 281 void exec_context_dump(ExecContext *c, FILE* f, const char *prefix);
 282
 283 int exec_context_destroy_runtime_directory(ExecContext *c, const char *runtime_root);
 284
 285 int exec_context_load_environment(Unit *unit, const ExecContext *c, char ***l);
 286
 287 bool exec_context_may_touch_console(ExecContext *c);
 288 bool exec_context_maintains_privileges(ExecContext *c);
 289
 290 void exec_status_start(ExecStatus *s, pid_t pid);
 291 void exec_status_exit(ExecStatus *s, ExecContext *context, pid_t pid, int code, int status);
 292 void exec_status_dump(ExecStatus *s, FILE *f, const char *prefix);
 293
 294 int exec_runtime_make(ExecRuntime **rt, ExecContext *c, const char *id);
 295 ExecRuntime *exec_runtime_ref(ExecRuntime *r);
 296 ExecRuntime *exec_runtime_unref(ExecRuntime *r);
 297
 298 int exec_runtime_serialize(Unit *unit, ExecRuntime *rt, FILE *f, FDSet *fds);
 299 int exec_runtime_deserialize_item(Unit *unit, ExecRuntime **rt, const char *key, const char *value, FDSet *fds);
 300
 301 void exec_runtime_destroy(ExecRuntime *rt);
 302
 303 const char* exec_output_to_string(ExecOutput i) _const_;
 304 ExecOutput exec_output_from_string(const char *s) _pure_;
 305
 306 const char* exec_input_to_string(ExecInput i) _const_;
 307 ExecInput exec_input_from_string(const char *s) _pure_;
 308
 309 const char* exec_utmp_mode_to_string(ExecUtmpMode i) _const_;
 310 ExecUtmpMode exec_utmp_mode_from_string(const char *s) _pure_;