src/udev/udev-ctrl.c

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