src/udev/udev-ctrl.c

   1 /* SPDX-License-Identifier: LGPL-2.1+
   2  *
   3  * libudev - interface to udev device information
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  */
  10
  11 #include <errno.h>
  12 #include <poll.h>
  13 #include <stddef.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <sys/socket.h>
  17 #include <sys/un.h>
  18 #include <unistd.h>
  19
  20 #include "alloc-util.h"
  21 #include "fd-util.h"
  22 #include "format-util.h"
  23 #include "socket-util.h"
  24 #include "strxcpyx.h"
  25 #include "udev-ctrl.h"
  26
  27 /* wire protocol magic must match */
  28 #define UDEV_CTRL_MAGIC                                0xdead1dea
  29
  30 enum udev_ctrl_msg_type {
  31         UDEV_CTRL_UNKNOWN,
  32         UDEV_CTRL_SET_LOG_LEVEL,
  33         UDEV_CTRL_STOP_EXEC_QUEUE,
  34         UDEV_CTRL_START_EXEC_QUEUE,
  35         UDEV_CTRL_RELOAD,
  36         UDEV_CTRL_SET_ENV,
  37         UDEV_CTRL_SET_CHILDREN_MAX,
  38         UDEV_CTRL_PING,
  39         UDEV_CTRL_EXIT,
  40 };
  41
  42 struct udev_ctrl_msg_wire {
  43         char version[16];
  44         unsigned int magic;
  45         enum udev_ctrl_msg_type type;
  46         union {
  47                 int intval;
  48                 char buf[256];
  49         };
  50 };
  51
  52 struct udev_ctrl_msg {
  53         unsigned n_ref;
  54         struct udev_ctrl_connection *conn;
  55         struct udev_ctrl_msg_wire ctrl_msg_wire;
  56 };
  57
  58 struct udev_ctrl {
  59         unsigned n_ref;
  60         int sock;
  61         union sockaddr_union saddr;
  62         socklen_t addrlen;
  63         bool bound;
  64         bool cleanup_socket;
  65         bool connected;
  66 };
  67
  68 struct udev_ctrl_connection {
  69         unsigned n_ref;
  70         struct udev_ctrl *uctrl;
  71         int sock;
  72 };
  73
  74 struct udev_ctrl *udev_ctrl_new_from_fd(int fd) {
  75         struct udev_ctrl *uctrl;
  76         int r;
  77
  78         uctrl = new0(struct udev_ctrl, 1);
  79         if (uctrl == NULL)
  80                 return NULL;
  81         uctrl->n_ref = 1;
  82
  83         if (fd < 0) {
  84                 uctrl->sock = socket(AF_LOCAL, SOCK_SEQPACKET|SOCK_NONBLOCK|SOCK_CLOEXEC, 0);
  85                 if (uctrl->sock < 0) {
  86                         log_error_errno(errno, "error getting socket: %m");
  87                         udev_ctrl_unref(uctrl);
  88                         return NULL;
  89                 }
  90         } else {
  91                 uctrl->bound = true;
  92                 uctrl->sock = fd;
  93         }
  94
  95         /*
  96          * FIXME: remove it as soon as we can depend on this:
  97          *   http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=90c6bd34f884cd9cee21f1d152baf6c18bcac949
  98          */
  99         r = setsockopt(uctrl->sock, SOL_SOCKET, SO_PASSCRED, &const_int_one, sizeof(const_int_one));
 100         if (r < 0)
 101                 log_warning_errno(errno, "could not set SO_PASSCRED: %m");
 102
 103         uctrl->saddr.un = (struct sockaddr_un) {
 104                 .sun_family = AF_UNIX,
 105                 .sun_path = "/run/udev/control",
 106         };
 107
 108         uctrl->addrlen = SOCKADDR_UN_LEN(uctrl->saddr.un);
 109         return uctrl;
 110 }
 111
 112 struct udev_ctrl *udev_ctrl_new(void) {
 113         return udev_ctrl_new_from_fd(-1);
 114 }
 115
 116 int udev_ctrl_enable_receiving(struct udev_ctrl *uctrl) {
 117         int err;
 118
 119         if (!uctrl->bound) {
 120                 err = bind(uctrl->sock, &uctrl->saddr.sa, uctrl->addrlen);
 121                 if (err < 0 && errno == EADDRINUSE) {
 122                         (void) sockaddr_un_unlink(&uctrl->saddr.un);
 123                         err = bind(uctrl->sock, &uctrl->saddr.sa, uctrl->addrlen);
 124                 }
 125
 126                 if (err < 0)
 127                         return log_error_errno(errno, "bind failed: %m");
 128
 129                 err = listen(uctrl->sock, 0);
 130                 if (err < 0)
 131                         return log_error_errno(errno, "listen failed: %m");
 132
 133                 uctrl->bound = true;
 134                 uctrl->cleanup_socket = true;
 135         }
 136         return 0;
 137 }
 138
 139 static struct udev_ctrl *udev_ctrl_free(struct udev_ctrl *uctrl) {
 140         assert(uctrl);
 141
 142         safe_close(uctrl->sock);
 143         return mfree(uctrl);
 144 }
 145
 146 DEFINE_PRIVATE_TRIVIAL_REF_FUNC(struct udev_ctrl, udev_ctrl);
 147 DEFINE_TRIVIAL_UNREF_FUNC(struct udev_ctrl, udev_ctrl, udev_ctrl_free);
 148
 149 int udev_ctrl_cleanup(struct udev_ctrl *uctrl) {
 150         if (uctrl == NULL)
 151                 return 0;
 152         if (uctrl->cleanup_socket)
 153                 sockaddr_un_unlink(&uctrl->saddr.un);
 154         return 0;
 155 }
 156
 157 int udev_ctrl_get_fd(struct udev_ctrl *uctrl) {
 158         if (uctrl == NULL)
 159                 return -EINVAL;
 160         return uctrl->sock;
 161 }
 162
 163 struct udev_ctrl_connection *udev_ctrl_get_connection(struct udev_ctrl *uctrl) {
 164         struct udev_ctrl_connection *conn;
 165         struct ucred ucred = {};
 166         int r;
 167
 168         conn = new(struct udev_ctrl_connection, 1);
 169         if (conn == NULL)
 170                 return NULL;
 171         conn->n_ref = 1;
 172         conn->uctrl = uctrl;
 173
 174         conn->sock = accept4(uctrl->sock, NULL, NULL, SOCK_CLOEXEC|SOCK_NONBLOCK);
 175         if (conn->sock < 0) {
 176                 if (errno != EINTR)
 177                         log_error_errno(errno, "unable to receive ctrl connection: %m");
 178                 goto err;
 179         }
 180
 181         /* check peer credential of connection */
 182         r = getpeercred(conn->sock, &ucred);
 183         if (r < 0) {
 184                 log_error_errno(r, "unable to receive credentials of ctrl connection: %m");
 185                 goto err;
 186         }
 187         if (ucred.uid > 0) {
 188                 log_error("sender uid="UID_FMT", message ignored", ucred.uid);
 189                 goto err;
 190         }
 191
 192         /* enable receiving of the sender credentials in the messages */
 193         r = setsockopt(conn->sock, SOL_SOCKET, SO_PASSCRED, &const_int_one, sizeof(const_int_one));
 194         if (r < 0)
 195                 log_warning_errno(errno, "could not set SO_PASSCRED: %m");
 196
 197         udev_ctrl_ref(uctrl);
 198         return conn;
 199 err:
 200         if (conn->sock >= 0)
 201                 close(conn->sock);
 202         return mfree(conn);
 203 }
 204
 205 static struct udev_ctrl_connection *udev_ctrl_connection_free(struct udev_ctrl_connection *conn) {
 206         assert(conn);
 207
 208         safe_close(conn->sock);
 209         udev_ctrl_unref(conn->uctrl);
 210         return mfree(conn);
 211 }
 212
 213 DEFINE_TRIVIAL_REF_UNREF_FUNC(struct udev_ctrl_connection, udev_ctrl_connection, udev_ctrl_connection_free);
 214
 215 static int ctrl_send(struct udev_ctrl *uctrl, enum udev_ctrl_msg_type type, int intval, const char *buf, int timeout) {
 216         struct udev_ctrl_msg_wire ctrl_msg_wire;
 217         int err = 0;
 218
 219         memzero(&ctrl_msg_wire, sizeof(struct udev_ctrl_msg_wire));
 220         strcpy(ctrl_msg_wire.version, "udev-" PACKAGE_VERSION);
 221         ctrl_msg_wire.magic = UDEV_CTRL_MAGIC;
 222         ctrl_msg_wire.type = type;
 223
 224         if (buf != NULL)
 225                 strscpy(ctrl_msg_wire.buf, sizeof(ctrl_msg_wire.buf), buf);
 226         else
 227                 ctrl_msg_wire.intval = intval;
 228
 229         if (!uctrl->connected) {
 230                 if (connect(uctrl->sock, &uctrl->saddr.sa, uctrl->addrlen) < 0) {
 231                         err = -errno;
 232                         goto out;
 233                 }
 234                 uctrl->connected = true;
 235         }
 236         if (send(uctrl->sock, &ctrl_msg_wire, sizeof(ctrl_msg_wire), 0) < 0) {
 237                 err = -errno;
 238                 goto out;
 239         }
 240
 241         /* wait for peer message handling or disconnect */
 242         for (;;) {
 243                 struct pollfd pfd[1];
 244                 int r;
 245
 246                 pfd[0].fd = uctrl->sock;
 247                 pfd[0].events = POLLIN;
 248                 r = poll(pfd, 1, timeout * MSEC_PER_SEC);
 249                 if (r  < 0) {
 250                         if (errno == EINTR)
 251                                 continue;
 252                         err = -errno;
 253                         break;
 254                 }
 255
 256                 if (r > 0 && pfd[0].revents & POLLERR) {
 257                         err = -EIO;
 258                         break;
 259                 }
 260
 261                 if (r == 0)
 262                         err = -ETIMEDOUT;
 263                 break;
 264         }
 265 out:
 266         return err;
 267 }
 268
 269 int udev_ctrl_send_set_log_level(struct udev_ctrl *uctrl, int priority, int timeout) {
 270         return ctrl_send(uctrl, UDEV_CTRL_SET_LOG_LEVEL, priority, NULL, timeout);
 271 }
 272
 273 int udev_ctrl_send_stop_exec_queue(struct udev_ctrl *uctrl, int timeout) {
 274         return ctrl_send(uctrl, UDEV_CTRL_STOP_EXEC_QUEUE, 0, NULL, timeout);
 275 }
 276
 277 int udev_ctrl_send_start_exec_queue(struct udev_ctrl *uctrl, int timeout) {
 278         return ctrl_send(uctrl, UDEV_CTRL_START_EXEC_QUEUE, 0, NULL, timeout);
 279 }
 280
 281 int udev_ctrl_send_reload(struct udev_ctrl *uctrl, int timeout) {
 282         return ctrl_send(uctrl, UDEV_CTRL_RELOAD, 0, NULL, timeout);
 283 }
 284
 285 int udev_ctrl_send_set_env(struct udev_ctrl *uctrl, const char *key, int timeout) {
 286         return ctrl_send(uctrl, UDEV_CTRL_SET_ENV, 0, key, timeout);
 287 }
 288
 289 int udev_ctrl_send_set_children_max(struct udev_ctrl *uctrl, int count, int timeout) {
 290         return ctrl_send(uctrl, UDEV_CTRL_SET_CHILDREN_MAX, count, NULL, timeout);
 291 }
 292
 293 int udev_ctrl_send_ping(struct udev_ctrl *uctrl, int timeout) {
 294         return ctrl_send(uctrl, UDEV_CTRL_PING, 0, NULL, timeout);
 295 }
 296
 297 int udev_ctrl_send_exit(struct udev_ctrl *uctrl, int timeout) {
 298         return ctrl_send(uctrl, UDEV_CTRL_EXIT, 0, NULL, timeout);
 299 }
 300
 301 struct udev_ctrl_msg *udev_ctrl_receive_msg(struct udev_ctrl_connection *conn) {
 302         struct udev_ctrl_msg *uctrl_msg;
 303         ssize_t size;
 304         struct cmsghdr *cmsg;
 305         struct iovec iov;
 306         char cred_msg[CMSG_SPACE(sizeof(struct ucred))];
 307         struct msghdr smsg = {
 308                 .msg_iov = &iov,
 309                 .msg_iovlen = 1,
 310                 .msg_control = cred_msg,
 311                 .msg_controllen = sizeof(cred_msg),
 312         };
 313         struct ucred *cred;
 314
 315         uctrl_msg = new0(struct udev_ctrl_msg, 1);
 316         if (uctrl_msg == NULL)
 317                 return NULL;
 318         uctrl_msg->n_ref = 1;
 319         uctrl_msg->conn = conn;
 320         udev_ctrl_connection_ref(conn);
 321
 322         /* wait for the incoming message */
 323         for (;;) {
 324                 struct pollfd pfd[1];
 325                 int r;
 326
 327                 pfd[0].fd = conn->sock;
 328                 pfd[0].events = POLLIN;
 329
 330                 r = poll(pfd, 1, 10000);
 331                 if (r  < 0) {
 332                         if (errno == EINTR)
 333                                 continue;
 334                         goto err;
 335                 } else if (r == 0) {
 336                         log_error("timeout waiting for ctrl message");
 337                         goto err;
 338                 } else {
 339                         if (!(pfd[0].revents & POLLIN)) {
 340                                 log_error_errno(errno, "ctrl connection error: %m");
 341                                 goto err;
 342                         }
 343                 }
 344
 345                 break;
 346         }
 347
 348         iov.iov_base = &uctrl_msg->ctrl_msg_wire;
 349         iov.iov_len = sizeof(struct udev_ctrl_msg_wire);
 350
 351         size = recvmsg(conn->sock, &smsg, 0);
 352         if (size <  0) {
 353                 log_error_errno(errno, "unable to receive ctrl message: %m");
 354                 goto err;
 355         }
 356
 357         cmsg_close_all(&smsg);
 358
 359         cmsg = CMSG_FIRSTHDR(&smsg);
 360
 361         if (cmsg == NULL || cmsg->cmsg_type != SCM_CREDENTIALS) {
 362                 log_error("no sender credentials received, message ignored");
 363                 goto err;
 364         }
 365
 366         cred = (struct ucred *) CMSG_DATA(cmsg);
 367
 368         if (cred->uid != 0) {
 369                 log_error("sender uid="UID_FMT", message ignored", cred->uid);
 370                 goto err;
 371         }
 372
 373         if (uctrl_msg->ctrl_msg_wire.magic != UDEV_CTRL_MAGIC) {
 374                 log_error("message magic 0x%08x doesn't match, ignore it", uctrl_msg->ctrl_msg_wire.magic);
 375                 goto err;
 376         }
 377
 378         return uctrl_msg;
 379 err:
 380         udev_ctrl_msg_unref(uctrl_msg);
 381         return NULL;
 382 }
 383
 384 static struct udev_ctrl_msg *udev_ctrl_msg_free(struct udev_ctrl_msg *ctrl_msg) {
 385         assert(ctrl_msg);
 386
 387         udev_ctrl_connection_unref(ctrl_msg->conn);
 388         return mfree(ctrl_msg);
 389 }
 390
 391 DEFINE_TRIVIAL_UNREF_FUNC(struct udev_ctrl_msg, udev_ctrl_msg, udev_ctrl_msg_free);
 392
 393 int udev_ctrl_get_set_log_level(struct udev_ctrl_msg *ctrl_msg) {
 394         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_SET_LOG_LEVEL)
 395                 return ctrl_msg->ctrl_msg_wire.intval;
 396         return -1;
 397 }
 398
 399 int udev_ctrl_get_stop_exec_queue(struct udev_ctrl_msg *ctrl_msg) {
 400         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_STOP_EXEC_QUEUE)
 401                 return 1;
 402         return -1;
 403 }
 404
 405 int udev_ctrl_get_start_exec_queue(struct udev_ctrl_msg *ctrl_msg) {
 406         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_START_EXEC_QUEUE)
 407                 return 1;
 408         return -1;
 409 }
 410
 411 int udev_ctrl_get_reload(struct udev_ctrl_msg *ctrl_msg) {
 412         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_RELOAD)
 413                 return 1;
 414         return -1;
 415 }
 416
 417 const char *udev_ctrl_get_set_env(struct udev_ctrl_msg *ctrl_msg) {
 418         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_SET_ENV)
 419                 return ctrl_msg->ctrl_msg_wire.buf;
 420         return NULL;
 421 }
 422
 423 int udev_ctrl_get_set_children_max(struct udev_ctrl_msg *ctrl_msg) {
 424         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_SET_CHILDREN_MAX)
 425                 return ctrl_msg->ctrl_msg_wire.intval;
 426         return -1;
 427 }
 428
 429 int udev_ctrl_get_ping(struct udev_ctrl_msg *ctrl_msg) {
 430         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_PING)
 431                 return 1;
 432         return -1;
 433 }
 434
 435 int udev_ctrl_get_exit(struct udev_ctrl_msg *ctrl_msg) {
 436         if (ctrl_msg->ctrl_msg_wire.type == UDEV_CTRL_EXIT)
 437                 return 1;
 438         return -1;
 439 }