src/core/dbus-service.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2
   3 #include <stdio_ext.h>
   4 #include <fcntl.h>
   5
   6 #include "alloc-util.h"
   7 #include "async.h"
   8 #include "bus-internal.h"
   9 #include "bus-util.h"
  10 #include "dbus-cgroup.h"
  11 #include "dbus-execute.h"
  12 #include "dbus-kill.h"
  13 #include "dbus-service.h"
  14 #include "dbus-util.h"
  15 #include "exit-status.h"
  16 #include "fd-util.h"
  17 #include "fileio.h"
  18 #include "parse-util.h"
  19 #include "path-util.h"
  20 #include "service.h"
  21 #include "signal-util.h"
  22 #include "string-util.h"
  23 #include "strv.h"
  24 #include "unit.h"
  25
  26 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_type, service_type, ServiceType);
  27 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_result, service_result, ServiceResult);
  28 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_restart, service_restart, ServiceRestart);
  29 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_notify_access, notify_access, NotifyAccess);
  30 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_emergency_action, emergency_action, EmergencyAction);
  31
  32 static int property_get_exit_status_set(
  33                 sd_bus *bus,
  34                 const char *path,
  35                 const char *interface,
  36                 const char *property,
  37                 sd_bus_message *reply,
  38                 void *userdata,
  39                 sd_bus_error *error) {
  40
  41         ExitStatusSet *status_set = userdata;
  42         Iterator i;
  43         void *id;
  44         int r;
  45
  46         assert(bus);
  47         assert(reply);
  48         assert(status_set);
  49
  50         r = sd_bus_message_open_container(reply, 'r', "aiai");
  51         if (r < 0)
  52                 return r;
  53
  54         r = sd_bus_message_open_container(reply, 'a', "i");
  55         if (r < 0)
  56                 return r;
  57
  58         SET_FOREACH(id, status_set->status, i) {
  59                 int32_t val = PTR_TO_INT(id);
  60
  61                 if (val < 0 || val > 255)
  62                         continue;
  63
  64                 r = sd_bus_message_append_basic(reply, 'i', &val);
  65                 if (r < 0)
  66                         return r;
  67         }
  68
  69         r = sd_bus_message_close_container(reply);
  70         if (r < 0)
  71                 return r;
  72
  73         r = sd_bus_message_open_container(reply, 'a', "i");
  74         if (r < 0)
  75                 return r;
  76
  77         SET_FOREACH(id, status_set->signal, i) {
  78                 int32_t val = PTR_TO_INT(id);
  79                 const char *str;
  80
  81                 str = signal_to_string((int) val);
  82                 if (!str)
  83                         continue;
  84
  85                 r = sd_bus_message_append_basic(reply, 'i', &val);
  86                 if (r < 0)
  87                         return r;
  88         }
  89
  90         r = sd_bus_message_close_container(reply);
  91         if (r < 0)
  92                 return r;
  93
  94         return sd_bus_message_close_container(reply);
  95 }
  96
  97 const sd_bus_vtable bus_service_vtable[] = {
  98         SD_BUS_VTABLE_START(0),
  99         SD_BUS_PROPERTY("Type", "s", property_get_type, offsetof(Service, type), SD_BUS_VTABLE_PROPERTY_CONST),
 100         SD_BUS_PROPERTY("Restart", "s", property_get_restart, offsetof(Service, restart), SD_BUS_VTABLE_PROPERTY_CONST),
 101         SD_BUS_PROPERTY("PIDFile", "s", NULL, offsetof(Service, pid_file), SD_BUS_VTABLE_PROPERTY_CONST),
 102         SD_BUS_PROPERTY("NotifyAccess", "s", property_get_notify_access, offsetof(Service, notify_access), SD_BUS_VTABLE_PROPERTY_CONST),
 103         SD_BUS_PROPERTY("RestartUSec", "t", bus_property_get_usec, offsetof(Service, restart_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 104         SD_BUS_PROPERTY("TimeoutStartUSec", "t", bus_property_get_usec, offsetof(Service, timeout_start_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 105         SD_BUS_PROPERTY("TimeoutStopUSec", "t", bus_property_get_usec, offsetof(Service, timeout_stop_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 106         SD_BUS_PROPERTY("RuntimeMaxUSec", "t", bus_property_get_usec, offsetof(Service, runtime_max_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 107         SD_BUS_PROPERTY("WatchdogUSec", "t", bus_property_get_usec, offsetof(Service, watchdog_usec), SD_BUS_VTABLE_PROPERTY_CONST),
 108         BUS_PROPERTY_DUAL_TIMESTAMP("WatchdogTimestamp", offsetof(Service, watchdog_timestamp), 0),
 109         SD_BUS_PROPERTY("PermissionsStartOnly", "b", bus_property_get_bool, offsetof(Service, permissions_start_only), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN), /* 😷 deprecated */
 110         SD_BUS_PROPERTY("RootDirectoryStartOnly", "b", bus_property_get_bool, offsetof(Service, root_directory_start_only), SD_BUS_VTABLE_PROPERTY_CONST),
 111         SD_BUS_PROPERTY("RemainAfterExit", "b", bus_property_get_bool, offsetof(Service, remain_after_exit), SD_BUS_VTABLE_PROPERTY_CONST),
 112         SD_BUS_PROPERTY("GuessMainPID", "b", bus_property_get_bool, offsetof(Service, guess_main_pid), SD_BUS_VTABLE_PROPERTY_CONST),
 113         SD_BUS_PROPERTY("RestartPreventExitStatus", "(aiai)", property_get_exit_status_set, offsetof(Service, restart_prevent_status), SD_BUS_VTABLE_PROPERTY_CONST),
 114         SD_BUS_PROPERTY("RestartForceExitStatus", "(aiai)", property_get_exit_status_set, offsetof(Service, restart_force_status), SD_BUS_VTABLE_PROPERTY_CONST),
 115         SD_BUS_PROPERTY("SuccessExitStatus", "(aiai)", property_get_exit_status_set, offsetof(Service, success_status), SD_BUS_VTABLE_PROPERTY_CONST),
 116         SD_BUS_PROPERTY("MainPID", "u", bus_property_get_pid, offsetof(Service, main_pid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 117         SD_BUS_PROPERTY("ControlPID", "u", bus_property_get_pid, offsetof(Service, control_pid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 118         SD_BUS_PROPERTY("BusName", "s", NULL, offsetof(Service, bus_name), SD_BUS_VTABLE_PROPERTY_CONST),
 119         SD_BUS_PROPERTY("FileDescriptorStoreMax", "u", bus_property_get_unsigned, offsetof(Service, n_fd_store_max), SD_BUS_VTABLE_PROPERTY_CONST),
 120         SD_BUS_PROPERTY("NFileDescriptorStore", "u", bus_property_get_unsigned, offsetof(Service, n_fd_store), 0),
 121         SD_BUS_PROPERTY("StatusText", "s", NULL, offsetof(Service, status_text), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 122         SD_BUS_PROPERTY("StatusErrno", "i", bus_property_get_int, offsetof(Service, status_errno), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 123         SD_BUS_PROPERTY("Result", "s", property_get_result, offsetof(Service, result), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 124         SD_BUS_PROPERTY("ReloadResult", "s", property_get_result, offsetof(Service, reload_result), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 125         SD_BUS_PROPERTY("USBFunctionDescriptors", "s", NULL, offsetof(Service, usb_function_descriptors), SD_BUS_VTABLE_PROPERTY_CONST),
 126         SD_BUS_PROPERTY("USBFunctionStrings", "s", NULL, offsetof(Service, usb_function_strings), SD_BUS_VTABLE_PROPERTY_CONST),
 127         SD_BUS_PROPERTY("UID", "u", bus_property_get_uid, offsetof(Unit, ref_uid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 128         SD_BUS_PROPERTY("GID", "u", bus_property_get_gid, offsetof(Unit, ref_gid), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 129         SD_BUS_PROPERTY("NRestarts", "u", bus_property_get_unsigned, offsetof(Service, n_restarts), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 130
 131         BUS_EXEC_STATUS_VTABLE("ExecMain", offsetof(Service, main_exec_status), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 132         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStartPre", offsetof(Service, exec_command[SERVICE_EXEC_START_PRE]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 133         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStart", offsetof(Service, exec_command[SERVICE_EXEC_START]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 134         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStartPost", offsetof(Service, exec_command[SERVICE_EXEC_START_POST]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 135         BUS_EXEC_COMMAND_LIST_VTABLE("ExecReload", offsetof(Service, exec_command[SERVICE_EXEC_RELOAD]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 136         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStop", offsetof(Service, exec_command[SERVICE_EXEC_STOP]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 137         BUS_EXEC_COMMAND_LIST_VTABLE("ExecStopPost", offsetof(Service, exec_command[SERVICE_EXEC_STOP_POST]), SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION),
 138
 139         /* The following four are obsolete, and thus marked hidden here. They moved into the Unit interface */
 140         SD_BUS_PROPERTY("StartLimitInterval", "t", bus_property_get_usec, offsetof(Unit, start_limit.interval), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 141         SD_BUS_PROPERTY("StartLimitBurst", "u", bus_property_get_unsigned, offsetof(Unit, start_limit.burst), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 142         SD_BUS_PROPERTY("StartLimitAction", "s", property_get_emergency_action, offsetof(Unit, start_limit_action), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 143         SD_BUS_PROPERTY("FailureAction", "s", property_get_emergency_action, offsetof(Unit, failure_action), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 144         SD_BUS_PROPERTY("RebootArgument", "s", NULL, offsetof(Unit, reboot_arg), SD_BUS_VTABLE_PROPERTY_CONST|SD_BUS_VTABLE_HIDDEN),
 145         SD_BUS_VTABLE_END
 146 };
 147
 148 static int bus_set_transient_exit_status(
 149                 Unit *u,
 150                 const char *name,
 151                 ExitStatusSet *status_set,
 152                 sd_bus_message *message,
 153                 UnitWriteFlags flags,
 154                 sd_bus_error *error) {
 155
 156         const int32_t *status, *signal;
 157         size_t sz_status, sz_signal, i;
 158         int r;
 159
 160         r = sd_bus_message_enter_container(message, 'r', "aiai");
 161         if (r < 0)
 162                 return r;
 163
 164         r = sd_bus_message_read_array(message, 'i', (const void **) &status, &sz_status);
 165         if (r < 0)
 166                 return r;
 167
 168         r = sd_bus_message_read_array(message, 'i', (const void **) &signal, &sz_signal);
 169         if (r < 0)
 170                 return r;
 171
 172         r = sd_bus_message_exit_container(message);
 173         if (r < 0)
 174                 return r;
 175
 176         sz_status /= sizeof(int32_t);
 177         sz_signal /= sizeof(int32_t);
 178
 179         if (sz_status == 0 && sz_signal == 0 && !UNIT_WRITE_FLAGS_NOOP(flags)) {
 180                 exit_status_set_free(status_set);
 181                 unit_write_settingf(u, flags, name, "%s=", name);
 182                 return 1;
 183         }
 184
 185         for (i = 0; i < sz_status; i++) {
 186                 if (status[i] < 0 || status[i] > 255)
 187                         return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Invalid status code in %s: %"PRIi32, name, status[i]);
 188
 189                 if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 190                         r = set_ensure_allocated(&status_set->status, NULL);
 191                         if (r < 0)
 192                                 return r;
 193
 194                         r = set_put(status_set->status, INT_TO_PTR((int) status[i]));
 195                         if (r < 0)
 196                                 return r;
 197
 198                         unit_write_settingf(u, flags, name, "%s=%"PRIi32, name, status[i]);
 199                 }
 200         }
 201
 202         for (i = 0; i < sz_signal; i++) {
 203                 const char *str;
 204
 205                 str = signal_to_string((int) signal[i]);
 206                 if (!str)
 207                         return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Invalid signal in %s: %"PRIi32, name, signal[i]);
 208
 209                 if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 210                         r = set_ensure_allocated(&status_set->signal, NULL);
 211                         if (r < 0)
 212                                 return r;
 213
 214                         r = set_put(status_set->signal, INT_TO_PTR((int) signal[i]));
 215                         if (r < 0)
 216                                 return r;
 217
 218                         unit_write_settingf(u, flags, name, "%s=%s", name, str);
 219                 }
 220         }
 221
 222         return 1;
 223 }
 224
 225 static int bus_set_transient_std_fd(
 226                 Unit *u,
 227                 const char *name,
 228                 int *p,
 229                 bool *b,
 230                 sd_bus_message *message,
 231                 UnitWriteFlags flags,
 232                 sd_bus_error *error) {
 233
 234         int fd, r;
 235
 236         assert(p);
 237         assert(b);
 238
 239         r = sd_bus_message_read(message, "h", &fd);
 240         if (r < 0)
 241                 return r;
 242
 243         if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 244                 int copy;
 245
 246                 copy = fcntl(fd, F_DUPFD_CLOEXEC, 3);
 247                 if (copy < 0)
 248                         return -errno;
 249
 250                 asynchronous_close(*p);
 251                 *p = copy;
 252                 *b = true;
 253         }
 254
 255         return 1;
 256 }
 257 static BUS_DEFINE_SET_TRANSIENT_PARSE(notify_access, NotifyAccess, notify_access_from_string);
 258 static BUS_DEFINE_SET_TRANSIENT_PARSE(service_type, ServiceType, service_type_from_string);
 259 static BUS_DEFINE_SET_TRANSIENT_PARSE(service_restart, ServiceRestart, service_restart_from_string);
 260 static BUS_DEFINE_SET_TRANSIENT_STRING_WITH_CHECK(bus_name, service_name_is_valid);
 261
 262 static int bus_service_set_transient_property(
 263                 Service *s,
 264                 const char *name,
 265                 sd_bus_message *message,
 266                 UnitWriteFlags flags,
 267                 sd_bus_error *error) {
 268
 269         Unit *u = UNIT(s);
 270         ServiceExecCommand ci;
 271         int r;
 272
 273         assert(s);
 274         assert(name);
 275         assert(message);
 276
 277         flags |= UNIT_PRIVATE;
 278
 279         if (streq(name, "PermissionsStartOnly"))
 280                 return bus_set_transient_bool(u, name, &s->permissions_start_only, message, flags, error);
 281
 282         if (streq(name, "RootDirectoryStartOnly"))
 283                 return bus_set_transient_bool(u, name, &s->root_directory_start_only, message, flags, error);
 284
 285         if (streq(name, "RemainAfterExit"))
 286                 return bus_set_transient_bool(u, name, &s->remain_after_exit, message, flags, error);
 287
 288         if (streq(name, "GuessMainPID"))
 289                 return bus_set_transient_bool(u, name, &s->guess_main_pid, message, flags, error);
 290
 291         if (streq(name, "Type"))
 292                 return bus_set_transient_service_type(u, name, &s->type, message, flags, error);
 293
 294         if (streq(name, "RestartUSec"))
 295                 return bus_set_transient_usec(u, name, &s->restart_usec, message, flags, error);
 296
 297         if (streq(name, "TimeoutStartUSec")) {
 298                 r = bus_set_transient_usec(u, name, &s->timeout_start_usec, message, flags, error);
 299                 if (r >= 0 && !UNIT_WRITE_FLAGS_NOOP(flags))
 300                         s->start_timeout_defined = true;
 301
 302                 return r;
 303         }
 304
 305         if (streq(name, "TimeoutStopUSec"))
 306                 return bus_set_transient_usec(u, name, &s->timeout_stop_usec, message, flags, error);
 307
 308         if (streq(name, "RuntimeMaxUSec"))
 309                 return bus_set_transient_usec(u, name, &s->runtime_max_usec, message, flags, error);
 310
 311         if (streq(name, "WatchdogUSec"))
 312                 return bus_set_transient_usec(u, name, &s->watchdog_usec, message, flags, error);
 313
 314         if (streq(name, "FileDescriptorStoreMax"))
 315                 return bus_set_transient_unsigned(u, name, &s->n_fd_store_max, message, flags, error);
 316
 317         if (streq(name, "NotifyAccess"))
 318                 return bus_set_transient_notify_access(u, name, &s->notify_access, message, flags, error);
 319
 320         if (streq(name, "PIDFile")) {
 321                 _cleanup_free_ char *n = NULL;
 322                 const char *v, *e;
 323
 324                 r = sd_bus_message_read(message, "s", &v);
 325                 if (r < 0)
 326                         return r;
 327
 328                 if (!isempty(v)) {
 329                         n = path_make_absolute(v, u->manager->prefix[EXEC_DIRECTORY_RUNTIME]);
 330                         if (!n)
 331                                 return -ENOMEM;
 332
 333                         path_simplify(n, true);
 334
 335                         if (!path_is_normalized(n))
 336                                 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "PIDFile= path '%s' is not valid", n);
 337
 338                         e = path_startswith(n, "/var/run/");
 339                         if (e) {
 340                                 char *z;
 341
 342                                 z = strjoin("/run/", e);
 343                                 if (!z)
 344                                         return log_oom();
 345
 346                                 if (!UNIT_WRITE_FLAGS_NOOP(flags))
 347                                         log_unit_notice(u, "Transient unit's PIDFile= property references path below legacy directory /var/run, updating %s → %s; please update client accordingly.", n, z);
 348
 349                                 free_and_replace(n, z);
 350                         }
 351                 }
 352
 353                 if (!UNIT_WRITE_FLAGS_NOOP(flags)) {
 354                         free_and_replace(s->pid_file, n);
 355                         unit_write_settingf(u, flags, name, "%s=%s", name, strempty(s->pid_file));
 356                 }
 357
 358                 return 1;
 359         }
 360
 361         if (streq(name, "USBFunctionDescriptors"))
 362                 return bus_set_transient_path(u, name, &s->usb_function_descriptors, message, flags, error);
 363
 364         if (streq(name, "USBFunctionStrings"))
 365                 return bus_set_transient_path(u, name, &s->usb_function_strings, message, flags, error);
 366
 367         if (streq(name, "BusName"))
 368                 return bus_set_transient_bus_name(u, name, &s->bus_name, message, flags, error);
 369
 370         if (streq(name, "Restart"))
 371                 return bus_set_transient_service_restart(u, name, &s->restart, message, flags, error);
 372
 373         if (streq(name, "RestartPreventExitStatus"))
 374                 return bus_set_transient_exit_status(u, name, &s->restart_prevent_status, message, flags, error);
 375
 376         if (streq(name, "RestartForceExitStatus"))
 377                 return bus_set_transient_exit_status(u, name, &s->restart_force_status, message, flags, error);
 378
 379         if (streq(name, "SuccessExitStatus"))
 380                 return bus_set_transient_exit_status(u, name, &s->success_status, message, flags, error);
 381
 382         ci = service_exec_command_from_string(name);
 383         if (ci >= 0)
 384                 return bus_set_transient_exec_command(u, name, &s->exec_command[ci], message, flags, error);
 385
 386         if (streq(name, "StandardInputFileDescriptor"))
 387                 return bus_set_transient_std_fd(u, name, &s->stdin_fd, &s->exec_context.stdio_as_fds, message, flags, error);
 388
 389         if (streq(name, "StandardOutputFileDescriptor"))
 390                 return bus_set_transient_std_fd(u, name, &s->stdout_fd, &s->exec_context.stdio_as_fds, message, flags, error);
 391
 392         if (streq(name, "StandardErrorFileDescriptor"))
 393                 return bus_set_transient_std_fd(u, name, &s->stderr_fd, &s->exec_context.stdio_as_fds, message, flags, error);
 394
 395         return 0;
 396 }
 397
 398 int bus_service_set_property(
 399                 Unit *u,
 400                 const char *name,
 401                 sd_bus_message *message,
 402                 UnitWriteFlags flags,
 403                 sd_bus_error *error) {
 404
 405         Service *s = SERVICE(u);
 406         int r;
 407
 408         assert(s);
 409         assert(name);
 410         assert(message);
 411
 412         r = bus_cgroup_set_property(u, &s->cgroup_context, name, message, flags, error);
 413         if (r != 0)
 414                 return r;
 415
 416         if (u->transient && u->load_state == UNIT_STUB) {
 417                 /* This is a transient unit, let's load a little more */
 418
 419                 r = bus_service_set_transient_property(s, name, message, flags, error);
 420                 if (r != 0)
 421                         return r;
 422
 423                 r = bus_exec_context_set_transient_property(u, &s->exec_context, name, message, flags, error);
 424                 if (r != 0)
 425                         return r;
 426
 427                 r = bus_kill_context_set_transient_property(u, &s->kill_context, name, message, flags, error);
 428                 if (r != 0)
 429                         return r;
 430         }
 431
 432         return 0;
 433 }
 434
 435 int bus_service_commit_properties(Unit *u) {
 436         assert(u);
 437
 438         unit_invalidate_cgroup_members_masks(u);
 439         unit_realize_cgroup(u);
 440
 441         return 0;
 442 }