]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/varlink.c
3735c20773bc3a5923ca91b7d5d0c5c143429e3a
[thirdparty/systemd.git] / src / shared / varlink.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <malloc.h>
4 #include <poll.h>
5
6 #include <sd-daemon.h>
7
8 #include "alloc-util.h"
9 #include "errno-util.h"
10 #include "fd-util.h"
11 #include "glyph-util.h"
12 #include "hashmap.h"
13 #include "io-util.h"
14 #include "iovec-util.h"
15 #include "list.h"
16 #include "path-util.h"
17 #include "process-util.h"
18 #include "selinux-util.h"
19 #include "serialize.h"
20 #include "set.h"
21 #include "socket-util.h"
22 #include "string-table.h"
23 #include "string-util.h"
24 #include "strv.h"
25 #include "time-util.h"
26 #include "umask-util.h"
27 #include "user-util.h"
28 #include "varlink.h"
29 #include "varlink-internal.h"
30 #include "varlink-org.varlink.service.h"
31 #include "varlink-io.systemd.h"
32 #include "version.h"
33
34 #define VARLINK_DEFAULT_CONNECTIONS_MAX 4096U
35 #define VARLINK_DEFAULT_CONNECTIONS_PER_UID_MAX 1024U
36
37 #define VARLINK_DEFAULT_TIMEOUT_USEC (45U*USEC_PER_SEC)
38 #define VARLINK_BUFFER_MAX (16U*1024U*1024U)
39 #define VARLINK_READ_SIZE (64U*1024U)
40
41 typedef enum VarlinkState {
42 /* Client side states */
43 VARLINK_IDLE_CLIENT,
44 VARLINK_AWAITING_REPLY,
45 VARLINK_AWAITING_REPLY_MORE,
46 VARLINK_CALLING,
47 VARLINK_CALLED,
48 VARLINK_PROCESSING_REPLY,
49
50 /* Server side states */
51 VARLINK_IDLE_SERVER,
52 VARLINK_PROCESSING_METHOD,
53 VARLINK_PROCESSING_METHOD_MORE,
54 VARLINK_PROCESSING_METHOD_ONEWAY,
55 VARLINK_PROCESSED_METHOD,
56 VARLINK_PENDING_METHOD,
57 VARLINK_PENDING_METHOD_MORE,
58
59 /* Common states (only during shutdown) */
60 VARLINK_PENDING_DISCONNECT,
61 VARLINK_PENDING_TIMEOUT,
62 VARLINK_PROCESSING_DISCONNECT,
63 VARLINK_PROCESSING_TIMEOUT,
64 VARLINK_PROCESSING_FAILURE,
65 VARLINK_DISCONNECTED,
66
67 _VARLINK_STATE_MAX,
68 _VARLINK_STATE_INVALID = -EINVAL,
69 } VarlinkState;
70
71 /* Tests whether we are not yet disconnected. Note that this is true during all states where the connection
72 * is still good for something, and false only when it's dead for good. This means: when we are
73 * asynchronously connecting to a peer and the connect() is still pending, then this will return 'true', as
74 * the connection is still good, and we are likely to be able to properly operate on it soon. */
75 #define VARLINK_STATE_IS_ALIVE(state) \
76 IN_SET(state, \
77 VARLINK_IDLE_CLIENT, \
78 VARLINK_AWAITING_REPLY, \
79 VARLINK_AWAITING_REPLY_MORE, \
80 VARLINK_CALLING, \
81 VARLINK_CALLED, \
82 VARLINK_PROCESSING_REPLY, \
83 VARLINK_IDLE_SERVER, \
84 VARLINK_PROCESSING_METHOD, \
85 VARLINK_PROCESSING_METHOD_MORE, \
86 VARLINK_PROCESSING_METHOD_ONEWAY, \
87 VARLINK_PROCESSED_METHOD, \
88 VARLINK_PENDING_METHOD, \
89 VARLINK_PENDING_METHOD_MORE)
90
91 typedef struct VarlinkJsonQueueItem VarlinkJsonQueueItem;
92
93 /* A queued message we shall write into the socket, along with the file descriptors to send at the same
94 * time. This queue item binds them together so that message/fd boundaries are maintained throughout the
95 * whole pipeline. */
96 struct VarlinkJsonQueueItem {
97 LIST_FIELDS(VarlinkJsonQueueItem, queue);
98 JsonVariant *data;
99 size_t n_fds;
100 int fds[];
101 };
102
103 struct Varlink {
104 unsigned n_ref;
105
106 VarlinkServer *server;
107
108 VarlinkState state;
109 bool connecting; /* This boolean indicates whether the socket fd we are operating on is currently
110 * processing an asynchronous connect(). In that state we watch the socket for
111 * EPOLLOUT, but we refrain from calling read() or write() on the socket as that
112 * will trigger ENOTCONN. Note that this boolean is kept separate from the
113 * VarlinkState above on purpose: while the connect() is still not complete we
114 * already want to allow queuing of messages and similar. Thus it's nice to keep
115 * these two state concepts separate: the VarlinkState encodes what our own view of
116 * the connection is, i.e. whether we think it's a server, a client, and has
117 * something queued already, while 'connecting' tells us a detail about the
118 * transport used below, that should have no effect on how we otherwise accept and
119 * process operations from the user.
120 *
121 * Or to say this differently: VARLINK_STATE_IS_ALIVE(state) tells you whether the
122 * connection is good to use, even if it might not be fully connected
123 * yet. connecting=true then informs you that actually we are still connecting, and
124 * the connection is actually not established yet and thus any requests you enqueue
125 * now will still work fine but will be queued only, not sent yet, but that
126 * shouldn't stop you from using the connection, since eventually whatever you queue
127 * *will* be sent.
128 *
129 * Or to say this even differently: 'state' is a high-level ("application layer"
130 * high, if you so will) state, while 'conecting' is a low-level ("transport layer"
131 * low, if you so will) state, and while they are not entirely unrelated and
132 * sometimes propagate effects to each other they are only asynchronously connected
133 * at most. */
134 unsigned n_pending;
135
136 int fd;
137
138 char *input_buffer; /* valid data starts at input_buffer_index, ends at input_buffer_index+input_buffer_size */
139 size_t input_buffer_index;
140 size_t input_buffer_size;
141 size_t input_buffer_unscanned;
142
143 void *input_control_buffer;
144 size_t input_control_buffer_size;
145
146 char *output_buffer; /* valid data starts at output_buffer_index, ends at output_buffer_index+output_buffer_size */
147 size_t output_buffer_index;
148 size_t output_buffer_size;
149
150 int *input_fds; /* file descriptors associated with the data in input_buffer (for fd passing) */
151 size_t n_input_fds;
152
153 int *output_fds; /* file descriptors associated with the data in output_buffer (for fd passing) */
154 size_t n_output_fds;
155
156 /* Further messages to output not yet formatted into text, and thus not included in output_buffer
157 * yet. We keep them separate from output_buffer, to not violate fd message boundaries: we want that
158 * each fd that is sent is associated with its fds, and that fds cannot be accidentally associated
159 * with preceding or following messages. */
160 LIST_HEAD(VarlinkJsonQueueItem, output_queue);
161 VarlinkJsonQueueItem *output_queue_tail;
162
163 /* The fds to associate with the next message that is about to be enqueued. The user first pushes the
164 * fds it intends to send via varlink_push_fd() into this queue, and then once the message data is
165 * submitted we'll combine the fds and the message data into one. */
166 int *pushed_fds;
167 size_t n_pushed_fds;
168
169 VarlinkReply reply_callback;
170
171 JsonVariant *current;
172 VarlinkSymbol *current_method;
173
174 struct ucred ucred;
175 bool ucred_acquired:1;
176
177 bool write_disconnected:1;
178 bool read_disconnected:1;
179 bool prefer_read_write:1;
180 bool got_pollhup:1;
181
182 bool allow_fd_passing_input:1;
183 bool allow_fd_passing_output:1;
184
185 bool output_buffer_sensitive:1; /* whether to erase the output buffer after writing it to the socket */
186
187 int af; /* address family if socket; AF_UNSPEC if not socket; negative if not known */
188
189 usec_t timestamp;
190 usec_t timeout;
191
192 void *userdata;
193 char *description;
194
195 sd_event *event;
196 sd_event_source *io_event_source;
197 sd_event_source *time_event_source;
198 sd_event_source *quit_event_source;
199 sd_event_source *defer_event_source;
200
201 pid_t exec_pid;
202 };
203
204 typedef struct VarlinkServerSocket VarlinkServerSocket;
205
206 struct VarlinkServerSocket {
207 VarlinkServer *server;
208
209 int fd;
210 char *address;
211
212 sd_event_source *event_source;
213
214 LIST_FIELDS(VarlinkServerSocket, sockets);
215 };
216
217 struct VarlinkServer {
218 unsigned n_ref;
219 VarlinkServerFlags flags;
220
221 LIST_HEAD(VarlinkServerSocket, sockets);
222
223 Hashmap *methods; /* Fully qualified symbol name of a method → VarlinkMethod */
224 Hashmap *interfaces; /* Fully qualified interface name → VarlinkInterface* */
225 Hashmap *symbols; /* Fully qualified symbol name of method/error → VarlinkSymbol* */
226 VarlinkConnect connect_callback;
227 VarlinkDisconnect disconnect_callback;
228
229 sd_event *event;
230 int64_t event_priority;
231
232 unsigned n_connections;
233 Hashmap *by_uid; /* UID_TO_PTR(uid) → UINT_TO_PTR(n_connections) */
234
235 void *userdata;
236 char *description;
237
238 unsigned connections_max;
239 unsigned connections_per_uid_max;
240
241 bool exit_on_idle;
242 };
243
244 typedef struct VarlinkCollectContext {
245 JsonVariant *parameters;
246 const char *error_id;
247 VarlinkReplyFlags flags;
248 } VarlinkCollectContext ;
249
250 static const char* const varlink_state_table[_VARLINK_STATE_MAX] = {
251 [VARLINK_IDLE_CLIENT] = "idle-client",
252 [VARLINK_AWAITING_REPLY] = "awaiting-reply",
253 [VARLINK_AWAITING_REPLY_MORE] = "awaiting-reply-more",
254 [VARLINK_CALLING] = "calling",
255 [VARLINK_CALLED] = "called",
256 [VARLINK_PROCESSING_REPLY] = "processing-reply",
257 [VARLINK_IDLE_SERVER] = "idle-server",
258 [VARLINK_PROCESSING_METHOD] = "processing-method",
259 [VARLINK_PROCESSING_METHOD_MORE] = "processing-method-more",
260 [VARLINK_PROCESSING_METHOD_ONEWAY] = "processing-method-oneway",
261 [VARLINK_PROCESSED_METHOD] = "processed-method",
262 [VARLINK_PENDING_METHOD] = "pending-method",
263 [VARLINK_PENDING_METHOD_MORE] = "pending-method-more",
264 [VARLINK_PENDING_DISCONNECT] = "pending-disconnect",
265 [VARLINK_PENDING_TIMEOUT] = "pending-timeout",
266 [VARLINK_PROCESSING_DISCONNECT] = "processing-disconnect",
267 [VARLINK_PROCESSING_TIMEOUT] = "processing-timeout",
268 [VARLINK_PROCESSING_FAILURE] = "processing-failure",
269 [VARLINK_DISCONNECTED] = "disconnected",
270 };
271
272 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(varlink_state, VarlinkState);
273
274 #define varlink_log_errno(v, error, fmt, ...) \
275 log_debug_errno(error, "%s: " fmt, varlink_description(v), ##__VA_ARGS__)
276
277 #define varlink_log(v, fmt, ...) \
278 log_debug("%s: " fmt, varlink_description(v), ##__VA_ARGS__)
279
280 #define varlink_server_log_errno(s, error, fmt, ...) \
281 log_debug_errno(error, "%s: " fmt, varlink_server_description(s), ##__VA_ARGS__)
282
283 #define varlink_server_log(s, fmt, ...) \
284 log_debug("%s: " fmt, varlink_server_description(s), ##__VA_ARGS__)
285
286 static int varlink_format_queue(Varlink *v);
287 static void varlink_server_test_exit_on_idle(VarlinkServer *s);
288
289 static const char *varlink_description(Varlink *v) {
290 return (v ? v->description : NULL) ?: "varlink";
291 }
292
293 static const char *varlink_server_description(VarlinkServer *s) {
294 return (s ? s->description : NULL) ?: "varlink";
295 }
296
297 static VarlinkJsonQueueItem *varlink_json_queue_item_free(VarlinkJsonQueueItem *q) {
298 if (!q)
299 return NULL;
300
301 json_variant_unref(q->data);
302 close_many(q->fds, q->n_fds);
303
304 return mfree(q);
305 }
306
307 static VarlinkJsonQueueItem *varlink_json_queue_item_new(JsonVariant *m, const int fds[], size_t n_fds) {
308 VarlinkJsonQueueItem *q;
309
310 assert(m);
311 assert(fds || n_fds == 0);
312
313 q = malloc(offsetof(VarlinkJsonQueueItem, fds) + sizeof(int) * n_fds);
314 if (!q)
315 return NULL;
316
317 *q = (VarlinkJsonQueueItem) {
318 .data = json_variant_ref(m),
319 .n_fds = n_fds,
320 };
321
322 memcpy_safe(q->fds, fds, n_fds * sizeof(int));
323
324 return TAKE_PTR(q);
325 }
326
327 static void varlink_set_state(Varlink *v, VarlinkState state) {
328 assert(v);
329 assert(state >= 0 && state < _VARLINK_STATE_MAX);
330
331 if (v->state < 0)
332 varlink_log(v, "Setting state %s",
333 varlink_state_to_string(state));
334 else
335 varlink_log(v, "Changing state %s %s %s",
336 varlink_state_to_string(v->state),
337 special_glyph(SPECIAL_GLYPH_ARROW_RIGHT),
338 varlink_state_to_string(state));
339
340 v->state = state;
341 }
342
343 static int varlink_new(Varlink **ret) {
344 Varlink *v;
345
346 assert(ret);
347
348 v = new(Varlink, 1);
349 if (!v)
350 return -ENOMEM;
351
352 *v = (Varlink) {
353 .n_ref = 1,
354 .fd = -EBADF,
355
356 .state = _VARLINK_STATE_INVALID,
357
358 .ucred = UCRED_INVALID,
359
360 .timestamp = USEC_INFINITY,
361 .timeout = VARLINK_DEFAULT_TIMEOUT_USEC,
362
363 .af = -1,
364 };
365
366 *ret = v;
367 return 0;
368 }
369
370 int varlink_connect_address(Varlink **ret, const char *address) {
371 _cleanup_(varlink_unrefp) Varlink *v = NULL;
372 union sockaddr_union sockaddr;
373 int r;
374
375 assert_return(ret, -EINVAL);
376 assert_return(address, -EINVAL);
377
378 r = varlink_new(&v);
379 if (r < 0)
380 return log_debug_errno(r, "Failed to create varlink object: %m");
381
382 v->fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
383 if (v->fd < 0)
384 return log_debug_errno(errno, "Failed to create AF_UNIX socket: %m");
385
386 v->fd = fd_move_above_stdio(v->fd);
387 v->af = AF_UNIX;
388
389 r = sockaddr_un_set_path(&sockaddr.un, address);
390 if (r < 0) {
391 if (r != -ENAMETOOLONG)
392 return log_debug_errno(r, "Failed to set socket address '%s': %m", address);
393
394 /* This is a file system path, and too long to fit into sockaddr_un. Let's connect via O_PATH
395 * to this socket. */
396
397 r = connect_unix_path(v->fd, AT_FDCWD, address);
398 } else
399 r = RET_NERRNO(connect(v->fd, &sockaddr.sa, r));
400
401 if (r < 0) {
402 if (!IN_SET(r, -EAGAIN, -EINPROGRESS))
403 return log_debug_errno(r, "Failed to connect to %s: %m", address);
404
405 v->connecting = true; /* We are asynchronously connecting, i.e. the connect() is being
406 * processed in the background. As long as that's the case the socket
407 * is in a special state: it's there, we can poll it for EPOLLOUT, but
408 * if we attempt to write() to it before we see EPOLLOUT we'll get
409 * ENOTCONN (and not EAGAIN, like we would for a normal connected
410 * socket that isn't writable at the moment). Since ENOTCONN on write()
411 * hence can mean two different things (i.e. connection not complete
412 * yet vs. already disconnected again), we store as a boolean whether
413 * we are still in connect(). */
414 }
415
416 varlink_set_state(v, VARLINK_IDLE_CLIENT);
417
418 *ret = TAKE_PTR(v);
419 return 0;
420 }
421
422 int varlink_connect_exec(Varlink **ret, const char *_command, char **_argv) {
423 _cleanup_close_pair_ int pair[2] = EBADF_PAIR;
424 _cleanup_(sigkill_waitp) pid_t pid = 0;
425 _cleanup_free_ char *command = NULL;
426 _cleanup_strv_free_ char **argv = NULL;
427 int r;
428
429 assert_return(ret, -EINVAL);
430 assert_return(_command, -EINVAL);
431
432 /* Copy the strings, in case they point into our own argv[], which we'll invalidate shortly because
433 * we rename the child process */
434 command = strdup(_command);
435 if (!command)
436 return -ENOMEM;
437
438 if (strv_isempty(_argv))
439 argv = strv_new(command);
440 else
441 argv = strv_copy(_argv);
442 if (!argv)
443 return -ENOMEM;
444
445 log_debug("Forking off Varlink child process '%s'.", command);
446
447 if (socketpair(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0, pair) < 0)
448 return log_debug_errno(errno, "Failed to allocate AF_UNIX socket pair: %m");
449
450 r = safe_fork_full(
451 "(sd-vlexec)",
452 /* stdio_fds= */ NULL,
453 /* except_fds= */ (int[]) { pair[1] },
454 /* n_except_fds= */ 1,
455 FORK_RESET_SIGNALS|FORK_CLOSE_ALL_FDS|FORK_DEATHSIG_SIGTERM|FORK_REOPEN_LOG|FORK_LOG|FORK_RLIMIT_NOFILE_SAFE,
456 &pid);
457 if (r < 0)
458 return log_debug_errno(r, "Failed to spawn process: %m");
459 if (r == 0) {
460 char spid[DECIMAL_STR_MAX(pid_t)+1];
461 const char *setenv_list[] = {
462 "LISTEN_FDS", "1",
463 "LISTEN_PID", spid,
464 "LISTEN_FDNAMES", "varlink",
465 NULL, NULL,
466 };
467 /* Child */
468
469 pair[0] = -EBADF;
470
471 r = move_fd(pair[1], 3, /* cloexec= */ false);
472 if (r < 0) {
473 log_debug_errno(r, "Failed to move file descriptor to 3: %m");
474 _exit(EXIT_FAILURE);
475 }
476
477 xsprintf(spid, PID_FMT, pid);
478
479 STRV_FOREACH_PAIR(a, b, setenv_list) {
480 if (setenv(*a, *b, /* override= */ true) < 0) {
481 log_debug_errno(errno, "Failed to set environment variable '%s': %m", *a);
482 _exit(EXIT_FAILURE);
483 }
484 }
485
486 execvp(command, argv);
487 log_debug_errno(r, "Failed to invoke process '%s': %m", command);
488 _exit(EXIT_FAILURE);
489 }
490
491 pair[1] = safe_close(pair[1]);
492
493 Varlink *v;
494 r = varlink_new(&v);
495 if (r < 0)
496 return log_debug_errno(r, "Failed to create varlink object: %m");
497
498 v->fd = TAKE_FD(pair[0]);
499 v->af = AF_UNIX;
500 v->exec_pid = TAKE_PID(pid);
501 varlink_set_state(v, VARLINK_IDLE_CLIENT);
502
503 *ret = v;
504 return 0;
505 }
506
507 int varlink_connect_url(Varlink **ret, const char *url) {
508 _cleanup_free_ char *c = NULL;
509 const char *p;
510 bool exec;
511 int r;
512
513 assert_return(ret, -EINVAL);
514 assert_return(url, -EINVAL);
515
516 // FIXME: Add support for vsock:, ssh-exec:, ssh-unix: URL schemes here. (The latter with OpenSSH
517 // 9.4's -W switch for referencing remote AF_UNIX sockets.)
518
519 /* The Varlink URL scheme is a bit underdefined. We support only the unix: transport for now, plus an
520 * exec: transport we made up ourselves. Strictly speaking this shouldn't even be called URL, since
521 * it has nothing to do with Internet URLs by RFC. */
522
523 p = startswith(url, "unix:");
524 if (p)
525 exec = false;
526 else {
527 p = startswith(url, "exec:");
528 if (!p)
529 return log_debug_errno(SYNTHETIC_ERRNO(EPROTONOSUPPORT), "URL scheme not supported.");
530
531 exec = true;
532 }
533
534 /* The varlink.org reference C library supports more than just file system paths. We might want to
535 * support that one day too. For now simply refuse that. */
536 if (p[strcspn(p, ";?#")] != '\0')
537 return log_debug_errno(SYNTHETIC_ERRNO(EPROTONOSUPPORT), "URL parameterization with ';', '?', '#' not supported.");
538
539 if (exec || p[0] != '@') { /* no validity checks for abstract namespace */
540
541 if (!path_is_absolute(p))
542 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL), "Specified path not absolute, refusing.");
543
544 r = path_simplify_alloc(p, &c);
545 if (r < 0)
546 return r;
547
548 if (!path_is_normalized(c))
549 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL), "Specified path is not normalized, refusing.");
550 }
551
552 if (exec)
553 return varlink_connect_exec(ret, c, NULL);
554
555 return varlink_connect_address(ret, c ?: p);
556 }
557
558 int varlink_connect_fd(Varlink **ret, int fd) {
559 Varlink *v;
560 int r;
561
562 assert_return(ret, -EINVAL);
563 assert_return(fd >= 0, -EBADF);
564
565 r = fd_nonblock(fd, true);
566 if (r < 0)
567 return log_debug_errno(r, "Failed to make fd %d nonblocking: %m", fd);
568
569 r = varlink_new(&v);
570 if (r < 0)
571 return log_debug_errno(r, "Failed to create varlink object: %m");
572
573 v->fd = fd;
574 v->af = -1,
575 varlink_set_state(v, VARLINK_IDLE_CLIENT);
576
577 /* Note that if this function is called we assume the passed socket (if it is one) is already
578 * properly connected, i.e. any asynchronous connect() done on it already completed. Because of that
579 * we'll not set the 'connecting' boolean here, i.e. we don't need to avoid write()ing to the socket
580 * until the connection is fully set up. Behaviour here is hence a bit different from
581 * varlink_connect_address() above, as there we do handle asynchronous connections ourselves and
582 * avoid doing write() on it before we saw EPOLLOUT for the first time. */
583
584 *ret = v;
585 return 0;
586 }
587
588 static void varlink_detach_event_sources(Varlink *v) {
589 assert(v);
590
591 v->io_event_source = sd_event_source_disable_unref(v->io_event_source);
592 v->time_event_source = sd_event_source_disable_unref(v->time_event_source);
593 v->quit_event_source = sd_event_source_disable_unref(v->quit_event_source);
594 v->defer_event_source = sd_event_source_disable_unref(v->defer_event_source);
595 }
596
597 static void varlink_clear_current(Varlink *v) {
598 assert(v);
599
600 /* Clears the currently processed incoming message */
601 v->current = json_variant_unref(v->current);
602 v->current_method = NULL;
603
604 close_many(v->input_fds, v->n_input_fds);
605 v->input_fds = mfree(v->input_fds);
606 v->n_input_fds = 0;
607 }
608
609 static void varlink_clear(Varlink *v) {
610 assert(v);
611
612 varlink_detach_event_sources(v);
613
614 v->fd = safe_close(v->fd);
615
616 varlink_clear_current(v);
617
618 v->input_buffer = mfree(v->input_buffer);
619 v->output_buffer = v->output_buffer_sensitive ? erase_and_free(v->output_buffer) : mfree(v->output_buffer);
620
621 v->input_control_buffer = mfree(v->input_control_buffer);
622 v->input_control_buffer_size = 0;
623
624 close_many(v->output_fds, v->n_output_fds);
625 v->output_fds = mfree(v->output_fds);
626 v->n_output_fds = 0;
627
628 close_many(v->pushed_fds, v->n_pushed_fds);
629 v->pushed_fds = mfree(v->pushed_fds);
630 v->n_pushed_fds = 0;
631
632 LIST_CLEAR(queue, v->output_queue, varlink_json_queue_item_free);
633 v->output_queue_tail = NULL;
634
635 v->event = sd_event_unref(v->event);
636
637 if (v->exec_pid > 0) {
638 sigterm_wait(v->exec_pid);
639 v->exec_pid = 0;
640 }
641 }
642
643 static Varlink* varlink_destroy(Varlink *v) {
644 if (!v)
645 return NULL;
646
647 /* If this is called the server object must already been unreffed here. Why that? because when we
648 * linked up the varlink connection with the server object we took one ref in each direction */
649 assert(!v->server);
650
651 varlink_clear(v);
652
653 free(v->description);
654 return mfree(v);
655 }
656
657 DEFINE_TRIVIAL_REF_UNREF_FUNC(Varlink, varlink, varlink_destroy);
658
659 static int varlink_test_disconnect(Varlink *v) {
660 assert(v);
661
662 /* Tests whether we the connection has been terminated. We are careful to not stop processing it
663 * prematurely, since we want to handle half-open connections as well as possible and want to flush
664 * out and read data before we close down if we can. */
665
666 /* Already disconnected? */
667 if (!VARLINK_STATE_IS_ALIVE(v->state))
668 return 0;
669
670 /* Wait until connection setup is complete, i.e. until asynchronous connect() completes */
671 if (v->connecting)
672 return 0;
673
674 /* Still something to write and we can write? Stay around */
675 if (v->output_buffer_size > 0 && !v->write_disconnected)
676 return 0;
677
678 /* Both sides gone already? Then there's no need to stick around */
679 if (v->read_disconnected && v->write_disconnected)
680 goto disconnect;
681
682 /* If we are waiting for incoming data but the read side is shut down, disconnect. */
683 if (IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE, VARLINK_CALLING, VARLINK_IDLE_SERVER) && v->read_disconnected)
684 goto disconnect;
685
686 /* Similar, if are a client that hasn't written anything yet but the write side is dead, also
687 * disconnect. We also explicitly check for POLLHUP here since we likely won't notice the write side
688 * being down if we never wrote anything. */
689 if (v->state == VARLINK_IDLE_CLIENT && (v->write_disconnected || v->got_pollhup))
690 goto disconnect;
691
692 /* We are on the server side and still want to send out more replies, but we saw POLLHUP already, and
693 * either got no buffered bytes to write anymore or already saw a write error. In that case we should
694 * shut down the varlink link. */
695 if (IN_SET(v->state, VARLINK_PENDING_METHOD, VARLINK_PENDING_METHOD_MORE) && (v->write_disconnected || v->output_buffer_size == 0) && v->got_pollhup)
696 goto disconnect;
697
698 return 0;
699
700 disconnect:
701 varlink_set_state(v, VARLINK_PENDING_DISCONNECT);
702 return 1;
703 }
704
705 static int varlink_write(Varlink *v) {
706 ssize_t n;
707 int r;
708
709 assert(v);
710
711 if (!VARLINK_STATE_IS_ALIVE(v->state))
712 return 0;
713 if (v->connecting) /* Writing while we are still wait for a non-blocking connect() to complete will
714 * result in ENOTCONN, hence exit early here */
715 return 0;
716 if (v->write_disconnected)
717 return 0;
718
719 /* If needed let's convert some output queue json variants into text form */
720 r = varlink_format_queue(v);
721 if (r < 0)
722 return r;
723
724 if (v->output_buffer_size == 0)
725 return 0;
726
727 assert(v->fd >= 0);
728
729 if (v->n_output_fds > 0) { /* If we shall send fds along, we must use sendmsg() */
730 struct iovec iov = {
731 .iov_base = v->output_buffer + v->output_buffer_index,
732 .iov_len = v->output_buffer_size,
733 };
734 struct msghdr mh = {
735 .msg_iov = &iov,
736 .msg_iovlen = 1,
737 .msg_controllen = CMSG_SPACE(sizeof(int) * v->n_output_fds),
738 };
739
740 mh.msg_control = alloca0(mh.msg_controllen);
741
742 struct cmsghdr *control = CMSG_FIRSTHDR(&mh);
743 control->cmsg_len = CMSG_LEN(sizeof(int) * v->n_output_fds);
744 control->cmsg_level = SOL_SOCKET;
745 control->cmsg_type = SCM_RIGHTS;
746 memcpy(CMSG_DATA(control), v->output_fds, sizeof(int) * v->n_output_fds);
747
748 n = sendmsg(v->fd, &mh, MSG_DONTWAIT|MSG_NOSIGNAL);
749 } else {
750 /* We generally prefer recv()/send() (mostly because of MSG_NOSIGNAL) but also want to be compatible
751 * with non-socket IO, hence fall back automatically.
752 *
753 * Use a local variable to help gcc figure out that we set 'n' in all cases. */
754 bool prefer_write = v->prefer_read_write;
755 if (!prefer_write) {
756 n = send(v->fd, v->output_buffer + v->output_buffer_index, v->output_buffer_size, MSG_DONTWAIT|MSG_NOSIGNAL);
757 if (n < 0 && errno == ENOTSOCK)
758 prefer_write = v->prefer_read_write = true;
759 }
760 if (prefer_write)
761 n = write(v->fd, v->output_buffer + v->output_buffer_index, v->output_buffer_size);
762 }
763 if (n < 0) {
764 if (errno == EAGAIN)
765 return 0;
766
767 if (ERRNO_IS_DISCONNECT(errno)) {
768 /* If we get informed about a disconnect on write, then let's remember that, but not
769 * act on it just yet. Let's wait for read() to report the issue first. */
770 v->write_disconnected = true;
771 return 1;
772 }
773
774 return -errno;
775 }
776
777 if (v->output_buffer_sensitive)
778 explicit_bzero_safe(v->output_buffer + v->output_buffer_index, n);
779
780 v->output_buffer_size -= n;
781
782 if (v->output_buffer_size == 0) {
783 v->output_buffer_index = 0;
784 v->output_buffer_sensitive = false; /* We can reset the sensitive flag once the buffer is empty */
785 } else
786 v->output_buffer_index += n;
787
788 close_many(v->output_fds, v->n_output_fds);
789 v->n_output_fds = 0;
790
791 v->timestamp = now(CLOCK_MONOTONIC);
792 return 1;
793 }
794
795 #define VARLINK_FDS_MAX (16U*1024U)
796
797 static int varlink_read(Varlink *v) {
798 struct iovec iov;
799 struct msghdr mh;
800 size_t rs;
801 ssize_t n;
802 void *p;
803
804 assert(v);
805
806 if (!IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE, VARLINK_CALLING, VARLINK_IDLE_SERVER))
807 return 0;
808 if (v->connecting) /* read() on a socket while we are in connect() will fail with EINVAL, hence exit early here */
809 return 0;
810 if (v->current)
811 return 0;
812 if (v->input_buffer_unscanned > 0)
813 return 0;
814 if (v->read_disconnected)
815 return 0;
816
817 if (v->input_buffer_size >= VARLINK_BUFFER_MAX)
818 return -ENOBUFS;
819
820 assert(v->fd >= 0);
821
822 if (MALLOC_SIZEOF_SAFE(v->input_buffer) <= v->input_buffer_index + v->input_buffer_size) {
823 size_t add;
824
825 add = MIN(VARLINK_BUFFER_MAX - v->input_buffer_size, VARLINK_READ_SIZE);
826
827 if (v->input_buffer_index == 0) {
828
829 if (!GREEDY_REALLOC(v->input_buffer, v->input_buffer_size + add))
830 return -ENOMEM;
831
832 } else {
833 char *b;
834
835 b = new(char, v->input_buffer_size + add);
836 if (!b)
837 return -ENOMEM;
838
839 memcpy(b, v->input_buffer + v->input_buffer_index, v->input_buffer_size);
840
841 free_and_replace(v->input_buffer, b);
842 v->input_buffer_index = 0;
843 }
844 }
845
846 p = v->input_buffer + v->input_buffer_index + v->input_buffer_size;
847 rs = MALLOC_SIZEOF_SAFE(v->input_buffer) - (v->input_buffer_index + v->input_buffer_size);
848
849 if (v->allow_fd_passing_input) {
850 iov = IOVEC_MAKE(p, rs);
851
852 /* Allocate the fd buffer on the heap, since we need a lot of space potentially */
853 if (!v->input_control_buffer) {
854 v->input_control_buffer_size = CMSG_SPACE(sizeof(int) * VARLINK_FDS_MAX);
855 v->input_control_buffer = malloc(v->input_control_buffer_size);
856 if (!v->input_control_buffer)
857 return -ENOMEM;
858 }
859
860 mh = (struct msghdr) {
861 .msg_iov = &iov,
862 .msg_iovlen = 1,
863 .msg_control = v->input_control_buffer,
864 .msg_controllen = v->input_control_buffer_size,
865 };
866
867 n = recvmsg_safe(v->fd, &mh, MSG_DONTWAIT|MSG_CMSG_CLOEXEC);
868 } else {
869 bool prefer_read = v->prefer_read_write;
870 if (!prefer_read) {
871 n = recv(v->fd, p, rs, MSG_DONTWAIT);
872 if (n < 0 && errno == ENOTSOCK)
873 prefer_read = v->prefer_read_write = true;
874 }
875 if (prefer_read)
876 n = read(v->fd, p, rs);
877 }
878 if (n < 0) {
879 if (errno == EAGAIN)
880 return 0;
881
882 if (ERRNO_IS_DISCONNECT(errno)) {
883 v->read_disconnected = true;
884 return 1;
885 }
886
887 return -errno;
888 }
889 if (n == 0) { /* EOF */
890
891 if (v->allow_fd_passing_input)
892 cmsg_close_all(&mh);
893
894 v->read_disconnected = true;
895 return 1;
896 }
897
898 if (v->allow_fd_passing_input) {
899 struct cmsghdr* cmsg;
900
901 cmsg = cmsg_find(&mh, SOL_SOCKET, SCM_RIGHTS, (socklen_t) -1);
902 if (cmsg) {
903 size_t add;
904
905 /* We only allow file descriptors to be passed along with the first byte of a
906 * message. If they are passed with any other byte this is a protocol violation. */
907 if (v->input_buffer_size != 0) {
908 cmsg_close_all(&mh);
909 return -EPROTO;
910 }
911
912 add = (cmsg->cmsg_len - CMSG_LEN(0)) / sizeof(int);
913 if (add > INT_MAX - v->n_input_fds) {
914 cmsg_close_all(&mh);
915 return -EBADF;
916 }
917
918 if (!GREEDY_REALLOC(v->input_fds, v->n_input_fds + add)) {
919 cmsg_close_all(&mh);
920 return -ENOMEM;
921 }
922
923 memcpy_safe(v->input_fds + v->n_input_fds, CMSG_TYPED_DATA(cmsg, int), add * sizeof(int));
924 v->n_input_fds += add;
925 }
926 }
927
928 v->input_buffer_size += n;
929 v->input_buffer_unscanned += n;
930
931 return 1;
932 }
933
934 static int varlink_parse_message(Varlink *v) {
935 const char *e, *begin;
936 size_t sz;
937 int r;
938
939 assert(v);
940
941 if (v->current)
942 return 0;
943 if (v->input_buffer_unscanned <= 0)
944 return 0;
945
946 assert(v->input_buffer_unscanned <= v->input_buffer_size);
947 assert(v->input_buffer_index + v->input_buffer_size <= MALLOC_SIZEOF_SAFE(v->input_buffer));
948
949 begin = v->input_buffer + v->input_buffer_index;
950
951 e = memchr(begin + v->input_buffer_size - v->input_buffer_unscanned, 0, v->input_buffer_unscanned);
952 if (!e) {
953 v->input_buffer_unscanned = 0;
954 return 0;
955 }
956
957 sz = e - begin + 1;
958
959 varlink_log(v, "New incoming message: %s", begin); /* FIXME: should we output the whole message here before validation?
960 * This may produce a non-printable journal entry if the message
961 * is invalid. We may also expose privileged information. */
962
963 r = json_parse(begin, 0, &v->current, NULL, NULL);
964 if (r < 0) {
965 /* If we encounter a parse failure flush all data. We cannot possibly recover from this,
966 * hence drop all buffered data now. */
967 v->input_buffer_index = v->input_buffer_size = v->input_buffer_unscanned = 0;
968 return varlink_log_errno(v, r, "Failed to parse JSON: %m");
969 }
970
971 v->input_buffer_size -= sz;
972
973 if (v->input_buffer_size == 0)
974 v->input_buffer_index = 0;
975 else
976 v->input_buffer_index += sz;
977
978 v->input_buffer_unscanned = v->input_buffer_size;
979 return 1;
980 }
981
982 static int varlink_test_timeout(Varlink *v) {
983 assert(v);
984
985 if (!IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE, VARLINK_CALLING))
986 return 0;
987 if (v->timeout == USEC_INFINITY)
988 return 0;
989
990 if (now(CLOCK_MONOTONIC) < usec_add(v->timestamp, v->timeout))
991 return 0;
992
993 varlink_set_state(v, VARLINK_PENDING_TIMEOUT);
994
995 return 1;
996 }
997
998 static int varlink_dispatch_local_error(Varlink *v, const char *error) {
999 int r;
1000
1001 assert(v);
1002 assert(error);
1003
1004 if (!v->reply_callback)
1005 return 0;
1006
1007 r = v->reply_callback(v, NULL, error, VARLINK_REPLY_ERROR|VARLINK_REPLY_LOCAL, v->userdata);
1008 if (r < 0)
1009 varlink_log_errno(v, r, "Reply callback returned error, ignoring: %m");
1010
1011 return 1;
1012 }
1013
1014 static int varlink_dispatch_timeout(Varlink *v) {
1015 assert(v);
1016
1017 if (v->state != VARLINK_PENDING_TIMEOUT)
1018 return 0;
1019
1020 varlink_set_state(v, VARLINK_PROCESSING_TIMEOUT);
1021 varlink_dispatch_local_error(v, VARLINK_ERROR_TIMEOUT);
1022 varlink_close(v);
1023
1024 return 1;
1025 }
1026
1027 static int varlink_dispatch_disconnect(Varlink *v) {
1028 assert(v);
1029
1030 if (v->state != VARLINK_PENDING_DISCONNECT)
1031 return 0;
1032
1033 varlink_set_state(v, VARLINK_PROCESSING_DISCONNECT);
1034 varlink_dispatch_local_error(v, VARLINK_ERROR_DISCONNECTED);
1035 varlink_close(v);
1036
1037 return 1;
1038 }
1039
1040 static int varlink_sanitize_parameters(JsonVariant **v) {
1041 int r;
1042
1043 assert(v);
1044
1045 /* Varlink always wants a parameters list, hence make one if the caller doesn't want any */
1046 if (!*v)
1047 return json_variant_new_object(v, NULL, 0);
1048 if (json_variant_is_null(*v)) {
1049 JsonVariant *empty;
1050
1051 r = json_variant_new_object(&empty, NULL, 0);
1052 if (r < 0)
1053 return r;
1054
1055 json_variant_unref(*v);
1056 *v = empty;
1057 return 0;
1058 }
1059 if (!json_variant_is_object(*v))
1060 return -EINVAL;
1061
1062 return 0;
1063 }
1064
1065 static int varlink_dispatch_reply(Varlink *v) {
1066 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
1067 VarlinkReplyFlags flags = 0;
1068 const char *error = NULL;
1069 JsonVariant *e;
1070 const char *k;
1071 int r;
1072
1073 assert(v);
1074
1075 if (!IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE, VARLINK_CALLING))
1076 return 0;
1077 if (!v->current)
1078 return 0;
1079
1080 assert(v->n_pending > 0);
1081
1082 if (!json_variant_is_object(v->current))
1083 goto invalid;
1084
1085 JSON_VARIANT_OBJECT_FOREACH(k, e, v->current) {
1086
1087 if (streq(k, "error")) {
1088 if (error)
1089 goto invalid;
1090 if (!json_variant_is_string(e))
1091 goto invalid;
1092
1093 error = json_variant_string(e);
1094 flags |= VARLINK_REPLY_ERROR;
1095
1096 } else if (streq(k, "parameters")) {
1097 if (parameters)
1098 goto invalid;
1099 if (!json_variant_is_object(e) && !json_variant_is_null(e))
1100 goto invalid;
1101
1102 parameters = json_variant_ref(e);
1103
1104 } else if (streq(k, "continues")) {
1105 if (FLAGS_SET(flags, VARLINK_REPLY_CONTINUES))
1106 goto invalid;
1107
1108 if (!json_variant_is_boolean(e))
1109 goto invalid;
1110
1111 if (json_variant_boolean(e))
1112 flags |= VARLINK_REPLY_CONTINUES;
1113 } else
1114 goto invalid;
1115 }
1116
1117 /* Replies with 'continue' set are only OK if we set 'more' when the method call was initiated */
1118 if (v->state != VARLINK_AWAITING_REPLY_MORE && FLAGS_SET(flags, VARLINK_REPLY_CONTINUES))
1119 goto invalid;
1120
1121 /* An error is final */
1122 if (error && FLAGS_SET(flags, VARLINK_REPLY_CONTINUES))
1123 goto invalid;
1124
1125 r = varlink_sanitize_parameters(&parameters);
1126 if (r < 0)
1127 goto invalid;
1128
1129 if (IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE)) {
1130 varlink_set_state(v, VARLINK_PROCESSING_REPLY);
1131
1132 if (v->reply_callback) {
1133 r = v->reply_callback(v, parameters, error, flags, v->userdata);
1134 if (r < 0)
1135 varlink_log_errno(v, r, "Reply callback returned error, ignoring: %m");
1136 }
1137
1138 varlink_clear_current(v);
1139
1140 if (v->state == VARLINK_PROCESSING_REPLY) {
1141
1142 assert(v->n_pending > 0);
1143
1144 if (!FLAGS_SET(flags, VARLINK_REPLY_CONTINUES))
1145 v->n_pending--;
1146
1147 varlink_set_state(v,
1148 FLAGS_SET(flags, VARLINK_REPLY_CONTINUES) ? VARLINK_AWAITING_REPLY_MORE :
1149 v->n_pending == 0 ? VARLINK_IDLE_CLIENT : VARLINK_AWAITING_REPLY);
1150 }
1151 } else {
1152 assert(v->state == VARLINK_CALLING);
1153 varlink_set_state(v, VARLINK_CALLED);
1154 }
1155
1156 return 1;
1157
1158 invalid:
1159 varlink_set_state(v, VARLINK_PROCESSING_FAILURE);
1160 varlink_dispatch_local_error(v, VARLINK_ERROR_PROTOCOL);
1161 varlink_close(v);
1162
1163 return 1;
1164 }
1165
1166 static int generic_method_get_info(
1167 Varlink *link,
1168 JsonVariant *parameters,
1169 VarlinkMethodFlags flags,
1170 void *userdata) {
1171
1172 _cleanup_strv_free_ char **interfaces = NULL;
1173 _cleanup_free_ char *product = NULL;
1174 int r;
1175
1176 assert(link);
1177
1178 if (json_variant_elements(parameters) != 0)
1179 return varlink_errorb(link, VARLINK_ERROR_INVALID_PARAMETER,
1180 JSON_BUILD_OBJECT(
1181 JSON_BUILD_PAIR_VARIANT("parameter", json_variant_by_index(parameters, 0))));
1182
1183 product = strjoin("systemd (", program_invocation_short_name, ")");
1184 if (!product)
1185 return -ENOMEM;
1186
1187 VarlinkInterface *interface;
1188 HASHMAP_FOREACH(interface, ASSERT_PTR(link->server)->interfaces) {
1189 r = strv_extend(&interfaces, interface->name);
1190 if (r < 0)
1191 return r;
1192 }
1193
1194 strv_sort(interfaces);
1195
1196 return varlink_replyb(link, JSON_BUILD_OBJECT(
1197 JSON_BUILD_PAIR_STRING("vendor", "The systemd Project"),
1198 JSON_BUILD_PAIR_STRING("product", product),
1199 JSON_BUILD_PAIR_STRING("version", STRINGIFY(PROJECT_VERSION) " (" GIT_VERSION ")"),
1200 JSON_BUILD_PAIR_STRING("url", "https://systemd.io/"),
1201 JSON_BUILD_PAIR_STRV("interfaces", interfaces)));
1202 }
1203
1204 static int generic_method_get_interface_description(
1205 Varlink *link,
1206 JsonVariant *parameters,
1207 VarlinkMethodFlags flags,
1208 void *userdata) {
1209
1210 static const struct JsonDispatch dispatch_table[] = {
1211 { "interface", JSON_VARIANT_STRING, json_dispatch_const_string, 0, JSON_MANDATORY },
1212 {}
1213 };
1214 _cleanup_free_ char *text = NULL;
1215 const VarlinkInterface *interface;
1216 const char *name = NULL;
1217 int r;
1218
1219 assert(link);
1220
1221 r = json_dispatch(parameters, dispatch_table, 0, &name);
1222 if (r < 0)
1223 return r;
1224
1225 interface = hashmap_get(ASSERT_PTR(link->server)->interfaces, name);
1226 if (!interface)
1227 return varlink_errorb(link, VARLINK_ERROR_INTERFACE_NOT_FOUND,
1228 JSON_BUILD_OBJECT(
1229 JSON_BUILD_PAIR_STRING("interface", name)));
1230
1231 r = varlink_idl_format(interface, &text);
1232 if (r < 0)
1233 return r;
1234
1235 return varlink_replyb(link,
1236 JSON_BUILD_OBJECT(
1237 JSON_BUILD_PAIR_STRING("description", text)));
1238 }
1239
1240 static int varlink_dispatch_method(Varlink *v) {
1241 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
1242 VarlinkMethodFlags flags = 0;
1243 const char *method = NULL;
1244 JsonVariant *e;
1245 VarlinkMethod callback;
1246 const char *k;
1247 int r;
1248
1249 assert(v);
1250
1251 if (v->state != VARLINK_IDLE_SERVER)
1252 return 0;
1253 if (!v->current)
1254 return 0;
1255
1256 if (!json_variant_is_object(v->current))
1257 goto invalid;
1258
1259 JSON_VARIANT_OBJECT_FOREACH(k, e, v->current) {
1260
1261 if (streq(k, "method")) {
1262 if (method)
1263 goto invalid;
1264 if (!json_variant_is_string(e))
1265 goto invalid;
1266
1267 method = json_variant_string(e);
1268
1269 } else if (streq(k, "parameters")) {
1270 if (parameters)
1271 goto invalid;
1272 if (!json_variant_is_object(e) && !json_variant_is_null(e))
1273 goto invalid;
1274
1275 parameters = json_variant_ref(e);
1276
1277 } else if (streq(k, "oneway")) {
1278
1279 if ((flags & (VARLINK_METHOD_ONEWAY|VARLINK_METHOD_MORE)) != 0)
1280 goto invalid;
1281
1282 if (!json_variant_is_boolean(e))
1283 goto invalid;
1284
1285 if (json_variant_boolean(e))
1286 flags |= VARLINK_METHOD_ONEWAY;
1287
1288 } else if (streq(k, "more")) {
1289
1290 if ((flags & (VARLINK_METHOD_ONEWAY|VARLINK_METHOD_MORE)) != 0)
1291 goto invalid;
1292
1293 if (!json_variant_is_boolean(e))
1294 goto invalid;
1295
1296 if (json_variant_boolean(e))
1297 flags |= VARLINK_METHOD_MORE;
1298
1299 } else
1300 goto invalid;
1301 }
1302
1303 if (!method)
1304 goto invalid;
1305
1306 r = varlink_sanitize_parameters(&parameters);
1307 if (r < 0)
1308 goto fail;
1309
1310 varlink_set_state(v, (flags & VARLINK_METHOD_MORE) ? VARLINK_PROCESSING_METHOD_MORE :
1311 (flags & VARLINK_METHOD_ONEWAY) ? VARLINK_PROCESSING_METHOD_ONEWAY :
1312 VARLINK_PROCESSING_METHOD);
1313
1314 assert(v->server);
1315
1316 /* First consult user supplied method implementations */
1317 callback = hashmap_get(v->server->methods, method);
1318 if (!callback) {
1319 if (streq(method, "org.varlink.service.GetInfo"))
1320 callback = generic_method_get_info;
1321 else if (streq(method, "org.varlink.service.GetInterfaceDescription"))
1322 callback = generic_method_get_interface_description;
1323 }
1324
1325 if (callback) {
1326 bool invalid = false;
1327
1328 v->current_method = hashmap_get(v->server->symbols, method);
1329 if (!v->current_method)
1330 varlink_log(v, "No interface description defined for method '%s', not validating.", method);
1331 else {
1332 const char *bad_field;
1333
1334 r = varlink_idl_validate_method_call(v->current_method, parameters, &bad_field);
1335 if (r < 0) {
1336 varlink_log_errno(v, r, "Parameters for method %s() didn't pass validation on field '%s': %m", method, strna(bad_field));
1337
1338 if (IN_SET(v->state, VARLINK_PROCESSING_METHOD, VARLINK_PROCESSING_METHOD_MORE)) {
1339 r = varlink_errorb(v, VARLINK_ERROR_INVALID_PARAMETER, JSON_BUILD_OBJECT(JSON_BUILD_PAIR_STRING("parameter", bad_field)));
1340 if (r < 0)
1341 return r;
1342 }
1343 invalid = true;
1344 }
1345 }
1346
1347 if (!invalid) {
1348 r = callback(v, parameters, flags, v->userdata);
1349 if (r < 0) {
1350 varlink_log_errno(v, r, "Callback for %s returned error: %m", method);
1351
1352 /* We got an error back from the callback. Propagate it to the client if the method call remains unanswered. */
1353 if (IN_SET(v->state, VARLINK_PROCESSING_METHOD, VARLINK_PROCESSING_METHOD_MORE)) {
1354 r = varlink_error_errno(v, r);
1355 if (r < 0)
1356 return r;
1357 }
1358 }
1359 }
1360 } else if (IN_SET(v->state, VARLINK_PROCESSING_METHOD, VARLINK_PROCESSING_METHOD_MORE)) {
1361 r = varlink_errorb(v, VARLINK_ERROR_METHOD_NOT_FOUND, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method))));
1362 if (r < 0)
1363 return r;
1364 }
1365
1366 switch (v->state) {
1367
1368 case VARLINK_PROCESSED_METHOD: /* Method call is fully processed */
1369 case VARLINK_PROCESSING_METHOD_ONEWAY: /* ditto */
1370 varlink_clear_current(v);
1371 varlink_set_state(v, VARLINK_IDLE_SERVER);
1372 break;
1373
1374 case VARLINK_PROCESSING_METHOD: /* Method call wasn't replied to, will be replied to later */
1375 varlink_set_state(v, VARLINK_PENDING_METHOD);
1376 break;
1377
1378 case VARLINK_PROCESSING_METHOD_MORE: /* No reply for a "more" message was sent, more to come */
1379 varlink_set_state(v, VARLINK_PENDING_METHOD_MORE);
1380 break;
1381
1382 default:
1383 assert_not_reached();
1384 }
1385
1386 return 1;
1387
1388 invalid:
1389 r = -EINVAL;
1390
1391 fail:
1392 varlink_set_state(v, VARLINK_PROCESSING_FAILURE);
1393 varlink_dispatch_local_error(v, VARLINK_ERROR_PROTOCOL);
1394 varlink_close(v);
1395
1396 return r;
1397 }
1398
1399 int varlink_process(Varlink *v) {
1400 int r;
1401
1402 assert_return(v, -EINVAL);
1403
1404 if (v->state == VARLINK_DISCONNECTED)
1405 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1406
1407 varlink_ref(v);
1408
1409 r = varlink_write(v);
1410 if (r < 0)
1411 varlink_log_errno(v, r, "Write failed: %m");
1412 if (r != 0)
1413 goto finish;
1414
1415 r = varlink_dispatch_reply(v);
1416 if (r < 0)
1417 varlink_log_errno(v, r, "Reply dispatch failed: %m");
1418 if (r != 0)
1419 goto finish;
1420
1421 r = varlink_dispatch_method(v);
1422 if (r < 0)
1423 varlink_log_errno(v, r, "Method dispatch failed: %m");
1424 if (r != 0)
1425 goto finish;
1426
1427 r = varlink_parse_message(v);
1428 if (r < 0)
1429 varlink_log_errno(v, r, "Message parsing failed: %m");
1430 if (r != 0)
1431 goto finish;
1432
1433 r = varlink_read(v);
1434 if (r < 0)
1435 varlink_log_errno(v, r, "Read failed: %m");
1436 if (r != 0)
1437 goto finish;
1438
1439 r = varlink_test_disconnect(v);
1440 assert(r >= 0);
1441 if (r != 0)
1442 goto finish;
1443
1444 r = varlink_dispatch_disconnect(v);
1445 assert(r >= 0);
1446 if (r != 0)
1447 goto finish;
1448
1449 r = varlink_test_timeout(v);
1450 assert(r >= 0);
1451 if (r != 0)
1452 goto finish;
1453
1454 r = varlink_dispatch_timeout(v);
1455 assert(r >= 0);
1456 if (r != 0)
1457 goto finish;
1458
1459 finish:
1460 if (r >= 0 && v->defer_event_source) {
1461 int q;
1462
1463 /* If we did some processing, make sure we are called again soon */
1464 q = sd_event_source_set_enabled(v->defer_event_source, r > 0 ? SD_EVENT_ON : SD_EVENT_OFF);
1465 if (q < 0)
1466 r = varlink_log_errno(v, q, "Failed to enable deferred event source: %m");
1467 }
1468
1469 if (r < 0) {
1470 if (VARLINK_STATE_IS_ALIVE(v->state))
1471 /* Initiate disconnection */
1472 varlink_set_state(v, VARLINK_PENDING_DISCONNECT);
1473 else
1474 /* We failed while disconnecting, in that case close right away */
1475 varlink_close(v);
1476 }
1477
1478 varlink_unref(v);
1479 return r;
1480 }
1481
1482 static void handle_revents(Varlink *v, int revents) {
1483 assert(v);
1484
1485 if (v->connecting) {
1486 /* If we have seen POLLOUT or POLLHUP on a socket we are asynchronously waiting a connect()
1487 * to complete on, we know we are ready. We don't read the connection error here though,
1488 * we'll get the error on the next read() or write(). */
1489 if ((revents & (POLLOUT|POLLHUP)) == 0)
1490 return;
1491
1492 varlink_log(v, "Asynchronous connection completed.");
1493 v->connecting = false;
1494 } else {
1495 /* Note that we don't care much about POLLIN/POLLOUT here, we'll just try reading and writing
1496 * what we can. However, we do care about POLLHUP to detect connection termination even if we
1497 * momentarily don't want to read nor write anything. */
1498
1499 if (!FLAGS_SET(revents, POLLHUP))
1500 return;
1501
1502 varlink_log(v, "Got POLLHUP from socket.");
1503 v->got_pollhup = true;
1504 }
1505 }
1506
1507 int varlink_wait(Varlink *v, usec_t timeout) {
1508 int r, fd, events;
1509 usec_t t;
1510
1511 assert_return(v, -EINVAL);
1512
1513 if (v->state == VARLINK_DISCONNECTED)
1514 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1515
1516 r = varlink_get_timeout(v, &t);
1517 if (r < 0)
1518 return r;
1519 if (t != USEC_INFINITY) {
1520 usec_t n;
1521
1522 n = now(CLOCK_MONOTONIC);
1523 if (t < n)
1524 t = 0;
1525 else
1526 t = usec_sub_unsigned(t, n);
1527 }
1528
1529 if (timeout != USEC_INFINITY &&
1530 (t == USEC_INFINITY || timeout < t))
1531 t = timeout;
1532
1533 fd = varlink_get_fd(v);
1534 if (fd < 0)
1535 return fd;
1536
1537 events = varlink_get_events(v);
1538 if (events < 0)
1539 return events;
1540
1541 r = fd_wait_for_event(fd, events, t);
1542 if (ERRNO_IS_NEG_TRANSIENT(r)) /* Treat EINTR as not a timeout, but also nothing happened, and
1543 * the caller gets a chance to call back into us */
1544 return 1;
1545 if (r <= 0)
1546 return r;
1547
1548 handle_revents(v, r);
1549 return 1;
1550 }
1551
1552 int varlink_is_idle(Varlink *v) {
1553 assert_return(v, -EINVAL);
1554
1555 /* Returns true if there's nothing pending on the connection anymore, i.e. we processed all incoming
1556 * or outgoing messages fully, or finished disconnection */
1557
1558 return IN_SET(v->state, VARLINK_DISCONNECTED, VARLINK_IDLE_CLIENT, VARLINK_IDLE_SERVER);
1559 }
1560
1561 int varlink_get_fd(Varlink *v) {
1562
1563 assert_return(v, -EINVAL);
1564
1565 if (v->state == VARLINK_DISCONNECTED)
1566 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1567 if (v->fd < 0)
1568 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBADF), "No valid fd.");
1569
1570 return v->fd;
1571 }
1572
1573 int varlink_get_events(Varlink *v) {
1574 int ret = 0;
1575
1576 assert_return(v, -EINVAL);
1577
1578 if (v->state == VARLINK_DISCONNECTED)
1579 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1580
1581 if (v->connecting) /* When processing an asynchronous connect(), we only wait for EPOLLOUT, which
1582 * tells us that the connection is now complete. Before that we should neither
1583 * write() or read() from the fd. */
1584 return EPOLLOUT;
1585
1586 if (!v->read_disconnected &&
1587 IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE, VARLINK_CALLING, VARLINK_IDLE_SERVER) &&
1588 !v->current &&
1589 v->input_buffer_unscanned <= 0)
1590 ret |= EPOLLIN;
1591
1592 if (!v->write_disconnected &&
1593 v->output_buffer_size > 0)
1594 ret |= EPOLLOUT;
1595
1596 return ret;
1597 }
1598
1599 int varlink_get_timeout(Varlink *v, usec_t *ret) {
1600 assert_return(v, -EINVAL);
1601
1602 if (v->state == VARLINK_DISCONNECTED)
1603 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1604
1605 if (IN_SET(v->state, VARLINK_AWAITING_REPLY, VARLINK_AWAITING_REPLY_MORE, VARLINK_CALLING) &&
1606 v->timeout != USEC_INFINITY) {
1607 if (ret)
1608 *ret = usec_add(v->timestamp, v->timeout);
1609 return 1;
1610 } else {
1611 if (ret)
1612 *ret = USEC_INFINITY;
1613 return 0;
1614 }
1615 }
1616
1617 int varlink_flush(Varlink *v) {
1618 int ret = 0, r;
1619
1620 assert_return(v, -EINVAL);
1621
1622 if (v->state == VARLINK_DISCONNECTED)
1623 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1624
1625 for (;;) {
1626 if (v->output_buffer_size == 0)
1627 break;
1628 if (v->write_disconnected)
1629 return -ECONNRESET;
1630
1631 r = varlink_write(v);
1632 if (r < 0)
1633 return r;
1634 if (r > 0) {
1635 ret = 1;
1636 continue;
1637 }
1638
1639 r = fd_wait_for_event(v->fd, POLLOUT, USEC_INFINITY);
1640 if (ERRNO_IS_NEG_TRANSIENT(r))
1641 continue;
1642 if (r < 0)
1643 return varlink_log_errno(v, r, "Poll failed on fd: %m");
1644 assert(r > 0);
1645
1646 handle_revents(v, r);
1647 }
1648
1649 return ret;
1650 }
1651
1652 static void varlink_detach_server(Varlink *v) {
1653 VarlinkServer *saved_server;
1654 assert(v);
1655
1656 if (!v->server)
1657 return;
1658
1659 if (v->server->by_uid &&
1660 v->ucred_acquired &&
1661 uid_is_valid(v->ucred.uid)) {
1662 unsigned c;
1663
1664 c = PTR_TO_UINT(hashmap_get(v->server->by_uid, UID_TO_PTR(v->ucred.uid)));
1665 assert(c > 0);
1666
1667 if (c == 1)
1668 (void) hashmap_remove(v->server->by_uid, UID_TO_PTR(v->ucred.uid));
1669 else
1670 (void) hashmap_replace(v->server->by_uid, UID_TO_PTR(v->ucred.uid), UINT_TO_PTR(c - 1));
1671 }
1672
1673 assert(v->server->n_connections > 0);
1674 v->server->n_connections--;
1675
1676 /* If this is a connection associated to a server, then let's disconnect the server and the
1677 * connection from each other. This drops the dangling reference that connect_callback() set up. But
1678 * before we release the references, let's call the disconnection callback if it is defined. */
1679
1680 saved_server = TAKE_PTR(v->server);
1681
1682 if (saved_server->disconnect_callback)
1683 saved_server->disconnect_callback(saved_server, v, saved_server->userdata);
1684
1685 varlink_server_test_exit_on_idle(saved_server);
1686 varlink_server_unref(saved_server);
1687 varlink_unref(v);
1688 }
1689
1690 int varlink_close(Varlink *v) {
1691 assert_return(v, -EINVAL);
1692
1693 if (v->state == VARLINK_DISCONNECTED)
1694 return 0;
1695
1696 varlink_set_state(v, VARLINK_DISCONNECTED);
1697
1698 /* Let's take a reference first, since varlink_detach_server() might drop the final (dangling) ref
1699 * which would destroy us before we can call varlink_clear() */
1700 varlink_ref(v);
1701 varlink_detach_server(v);
1702 varlink_clear(v);
1703 varlink_unref(v);
1704
1705 return 1;
1706 }
1707
1708 Varlink* varlink_close_unref(Varlink *v) {
1709 if (!v)
1710 return NULL;
1711
1712 (void) varlink_close(v);
1713 return varlink_unref(v);
1714 }
1715
1716 Varlink* varlink_flush_close_unref(Varlink *v) {
1717 if (!v)
1718 return NULL;
1719
1720 (void) varlink_flush(v);
1721 return varlink_close_unref(v);
1722 }
1723
1724 static int varlink_format_json(Varlink *v, JsonVariant *m) {
1725 _cleanup_(erase_and_freep) char *text = NULL;
1726 int r;
1727
1728 assert(v);
1729 assert(m);
1730
1731 r = json_variant_format(m, 0, &text);
1732 if (r < 0)
1733 return r;
1734 assert(text[r] == '\0');
1735
1736 if (v->output_buffer_size + r + 1 > VARLINK_BUFFER_MAX)
1737 return -ENOBUFS;
1738
1739 varlink_log(v, "Sending message: %s", text);
1740
1741 if (v->output_buffer_size == 0) {
1742
1743 free_and_replace(v->output_buffer, text);
1744
1745 v->output_buffer_size = r + 1;
1746 v->output_buffer_index = 0;
1747
1748 } else if (v->output_buffer_index == 0) {
1749
1750 if (!GREEDY_REALLOC(v->output_buffer, v->output_buffer_size + r + 1))
1751 return -ENOMEM;
1752
1753 memcpy(v->output_buffer + v->output_buffer_size, text, r + 1);
1754 v->output_buffer_size += r + 1;
1755 } else {
1756 char *n;
1757 const size_t new_size = v->output_buffer_size + r + 1;
1758
1759 n = new(char, new_size);
1760 if (!n)
1761 return -ENOMEM;
1762
1763 memcpy(mempcpy(n, v->output_buffer + v->output_buffer_index, v->output_buffer_size), text, r + 1);
1764
1765 free_and_replace(v->output_buffer, n);
1766 v->output_buffer_size = new_size;
1767 v->output_buffer_index = 0;
1768 }
1769
1770 if (json_variant_is_sensitive(m))
1771 v->output_buffer_sensitive = true; /* Propagate sensitive flag */
1772 else
1773 text = mfree(text); /* No point in the erase_and_free() destructor declared above */
1774
1775 return 0;
1776 }
1777
1778 static int varlink_enqueue_json(Varlink *v, JsonVariant *m) {
1779 VarlinkJsonQueueItem *q;
1780
1781 assert(v);
1782 assert(m);
1783
1784 /* If there are no file descriptors to be queued and no queue entries yet we can shortcut things and
1785 * append this entry directly to the output buffer */
1786 if (v->n_pushed_fds == 0 && !v->output_queue)
1787 return varlink_format_json(v, m);
1788
1789 /* Otherwise add a queue entry for this */
1790 q = varlink_json_queue_item_new(m, v->pushed_fds, v->n_pushed_fds);
1791 if (!q)
1792 return -ENOMEM;
1793
1794 v->n_pushed_fds = 0; /* fds now belong to the queue entry */
1795
1796 LIST_INSERT_AFTER(queue, v->output_queue, v->output_queue_tail, q);
1797 v->output_queue_tail = q;
1798 return 0;
1799 }
1800
1801 static int varlink_format_queue(Varlink *v) {
1802 int r;
1803
1804 assert(v);
1805
1806 /* Takes entries out of the output queue and formats them into the output buffer. But only if this
1807 * would not corrupt our fd message boundaries */
1808
1809 while (v->output_queue) {
1810 _cleanup_free_ int *array = NULL;
1811 VarlinkJsonQueueItem *q = v->output_queue;
1812
1813 if (v->n_output_fds > 0) /* unwritten fds? if we'd add more we'd corrupt the fd message boundaries, hence wait */
1814 return 0;
1815
1816 if (q->n_fds > 0) {
1817 array = newdup(int, q->fds, q->n_fds);
1818 if (!array)
1819 return -ENOMEM;
1820 }
1821
1822 r = varlink_format_json(v, q->data);
1823 if (r < 0)
1824 return r;
1825
1826 /* Take possession of the queue element's fds */
1827 free(v->output_fds);
1828 v->output_fds = TAKE_PTR(array);
1829 v->n_output_fds = q->n_fds;
1830 q->n_fds = 0;
1831
1832 LIST_REMOVE(queue, v->output_queue, q);
1833 if (!v->output_queue)
1834 v->output_queue_tail = NULL;
1835
1836 varlink_json_queue_item_free(q);
1837 }
1838
1839 return 0;
1840 }
1841
1842 int varlink_send(Varlink *v, const char *method, JsonVariant *parameters) {
1843 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
1844 int r;
1845
1846 assert_return(v, -EINVAL);
1847 assert_return(method, -EINVAL);
1848
1849 if (v->state == VARLINK_DISCONNECTED)
1850 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1851
1852 /* We allow enqueuing multiple method calls at once! */
1853 if (!IN_SET(v->state, VARLINK_IDLE_CLIENT, VARLINK_AWAITING_REPLY))
1854 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
1855
1856 r = varlink_sanitize_parameters(&parameters);
1857 if (r < 0)
1858 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
1859
1860 r = json_build(&m, JSON_BUILD_OBJECT(
1861 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method)),
1862 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters)),
1863 JSON_BUILD_PAIR("oneway", JSON_BUILD_BOOLEAN(true))));
1864 if (r < 0)
1865 return varlink_log_errno(v, r, "Failed to build json message: %m");
1866
1867 r = varlink_enqueue_json(v, m);
1868 if (r < 0)
1869 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
1870
1871 /* No state change here, this is one-way only after all */
1872 v->timestamp = now(CLOCK_MONOTONIC);
1873 return 0;
1874 }
1875
1876 int varlink_sendb(Varlink *v, const char *method, ...) {
1877 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
1878 va_list ap;
1879 int r;
1880
1881 assert_return(v, -EINVAL);
1882
1883 va_start(ap, method);
1884 r = json_buildv(&parameters, ap);
1885 va_end(ap);
1886
1887 if (r < 0)
1888 return varlink_log_errno(v, r, "Failed to build json message: %m");
1889
1890 return varlink_send(v, method, parameters);
1891 }
1892
1893 int varlink_invoke(Varlink *v, const char *method, JsonVariant *parameters) {
1894 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
1895 int r;
1896
1897 assert_return(v, -EINVAL);
1898 assert_return(method, -EINVAL);
1899
1900 if (v->state == VARLINK_DISCONNECTED)
1901 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1902
1903 /* We allow enqueuing multiple method calls at once! */
1904 if (!IN_SET(v->state, VARLINK_IDLE_CLIENT, VARLINK_AWAITING_REPLY))
1905 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
1906
1907 r = varlink_sanitize_parameters(&parameters);
1908 if (r < 0)
1909 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
1910
1911 r = json_build(&m, JSON_BUILD_OBJECT(
1912 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method)),
1913 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters))));
1914 if (r < 0)
1915 return varlink_log_errno(v, r, "Failed to build json message: %m");
1916
1917 r = varlink_enqueue_json(v, m);
1918 if (r < 0)
1919 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
1920
1921 varlink_set_state(v, VARLINK_AWAITING_REPLY);
1922 v->n_pending++;
1923 v->timestamp = now(CLOCK_MONOTONIC);
1924
1925 return 0;
1926 }
1927
1928 int varlink_invokeb(Varlink *v, const char *method, ...) {
1929 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
1930 va_list ap;
1931 int r;
1932
1933 assert_return(v, -EINVAL);
1934
1935 va_start(ap, method);
1936 r = json_buildv(&parameters, ap);
1937 va_end(ap);
1938
1939 if (r < 0)
1940 return varlink_log_errno(v, r, "Failed to build json message: %m");
1941
1942 return varlink_invoke(v, method, parameters);
1943 }
1944
1945 int varlink_observe(Varlink *v, const char *method, JsonVariant *parameters) {
1946 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
1947 int r;
1948
1949 assert_return(v, -EINVAL);
1950 assert_return(method, -EINVAL);
1951
1952 if (v->state == VARLINK_DISCONNECTED)
1953 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
1954
1955 /* Note that we don't allow enqueuing multiple method calls when we are in more/continues mode! We
1956 * thus insist on an idle client here. */
1957 if (v->state != VARLINK_IDLE_CLIENT)
1958 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
1959
1960 r = varlink_sanitize_parameters(&parameters);
1961 if (r < 0)
1962 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
1963
1964 r = json_build(&m, JSON_BUILD_OBJECT(
1965 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method)),
1966 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters)),
1967 JSON_BUILD_PAIR("more", JSON_BUILD_BOOLEAN(true))));
1968 if (r < 0)
1969 return varlink_log_errno(v, r, "Failed to build json message: %m");
1970
1971 r = varlink_enqueue_json(v, m);
1972 if (r < 0)
1973 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
1974
1975 varlink_set_state(v, VARLINK_AWAITING_REPLY_MORE);
1976 v->n_pending++;
1977 v->timestamp = now(CLOCK_MONOTONIC);
1978
1979 return 0;
1980 }
1981
1982 int varlink_observeb(Varlink *v, const char *method, ...) {
1983 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
1984 va_list ap;
1985 int r;
1986
1987 assert_return(v, -EINVAL);
1988
1989 va_start(ap, method);
1990 r = json_buildv(&parameters, ap);
1991 va_end(ap);
1992
1993 if (r < 0)
1994 return varlink_log_errno(v, r, "Failed to build json message: %m");
1995
1996 return varlink_observe(v, method, parameters);
1997 }
1998
1999 int varlink_call(
2000 Varlink *v,
2001 const char *method,
2002 JsonVariant *parameters,
2003 JsonVariant **ret_parameters,
2004 const char **ret_error_id,
2005 VarlinkReplyFlags *ret_flags) {
2006
2007 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
2008 int r;
2009
2010 assert_return(v, -EINVAL);
2011 assert_return(method, -EINVAL);
2012
2013 if (v->state == VARLINK_DISCONNECTED)
2014 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
2015 if (v->state != VARLINK_IDLE_CLIENT)
2016 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
2017
2018 assert(v->n_pending == 0); /* n_pending can't be > 0 if we are in VARLINK_IDLE_CLIENT state */
2019
2020 /* If there was still a reply pinned from a previous call, now it's the time to get rid of it, so
2021 * that we can assign a new reply shortly. */
2022 varlink_clear_current(v);
2023
2024 r = varlink_sanitize_parameters(&parameters);
2025 if (r < 0)
2026 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
2027
2028 r = json_build(&m, JSON_BUILD_OBJECT(
2029 JSON_BUILD_PAIR("method", JSON_BUILD_STRING(method)),
2030 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters))));
2031 if (r < 0)
2032 return varlink_log_errno(v, r, "Failed to build json message: %m");
2033
2034 r = varlink_enqueue_json(v, m);
2035 if (r < 0)
2036 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
2037
2038 varlink_set_state(v, VARLINK_CALLING);
2039 v->n_pending++;
2040 v->timestamp = now(CLOCK_MONOTONIC);
2041
2042 while (v->state == VARLINK_CALLING) {
2043
2044 r = varlink_process(v);
2045 if (r < 0)
2046 return r;
2047 if (r > 0)
2048 continue;
2049
2050 r = varlink_wait(v, USEC_INFINITY);
2051 if (r < 0)
2052 return r;
2053 }
2054
2055 switch (v->state) {
2056
2057 case VARLINK_CALLED:
2058 assert(v->current);
2059
2060 varlink_set_state(v, VARLINK_IDLE_CLIENT);
2061 assert(v->n_pending == 1);
2062 v->n_pending--;
2063
2064 if (ret_parameters)
2065 *ret_parameters = json_variant_by_key(v->current, "parameters");
2066 if (ret_error_id)
2067 *ret_error_id = json_variant_string(json_variant_by_key(v->current, "error"));
2068 if (ret_flags)
2069 *ret_flags = 0;
2070
2071 return 1;
2072
2073 case VARLINK_PENDING_DISCONNECT:
2074 case VARLINK_DISCONNECTED:
2075 return varlink_log_errno(v, SYNTHETIC_ERRNO(ECONNRESET), "Connection was closed.");
2076
2077 case VARLINK_PENDING_TIMEOUT:
2078 return varlink_log_errno(v, SYNTHETIC_ERRNO(ETIME), "Connection timed out.");
2079
2080 default:
2081 assert_not_reached();
2082 }
2083 }
2084
2085 int varlink_callb(
2086 Varlink *v,
2087 const char *method,
2088 JsonVariant **ret_parameters,
2089 const char **ret_error_id,
2090 VarlinkReplyFlags *ret_flags, ...) {
2091
2092 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
2093 va_list ap;
2094 int r;
2095
2096 assert_return(v, -EINVAL);
2097
2098 va_start(ap, ret_flags);
2099 r = json_buildv(&parameters, ap);
2100 va_end(ap);
2101
2102 if (r < 0)
2103 return varlink_log_errno(v, r, "Failed to build json message: %m");
2104
2105 return varlink_call(v, method, parameters, ret_parameters, ret_error_id, ret_flags);
2106 }
2107
2108 static void varlink_collect_context_free(VarlinkCollectContext *cc) {
2109 assert(cc);
2110
2111 json_variant_unref(cc->parameters);
2112 free((char *)cc->error_id);
2113 }
2114
2115 static int collect_callback(
2116 Varlink *v,
2117 JsonVariant *parameters,
2118 const char *error_id,
2119 VarlinkReplyFlags flags,
2120 void *userdata) {
2121
2122 VarlinkCollectContext *context = ASSERT_PTR(userdata);
2123 int r;
2124
2125 assert(v);
2126
2127 context->flags = flags;
2128 /* If we hit an error, we will drop all collected replies and just return the error_id and flags in varlink_collect() */
2129 if (error_id) {
2130 context->error_id = error_id;
2131 return 0;
2132 }
2133
2134 r = json_variant_append_array(&context->parameters, parameters);
2135 if (r < 0)
2136 return varlink_log_errno(v, r, "Failed to append JSON object to array: %m");
2137
2138 return 1;
2139 }
2140
2141 int varlink_collect(
2142 Varlink *v,
2143 const char *method,
2144 JsonVariant *parameters,
2145 JsonVariant **ret_parameters,
2146 const char **ret_error_id,
2147 VarlinkReplyFlags *ret_flags) {
2148
2149 _cleanup_(varlink_collect_context_free) VarlinkCollectContext context = {};
2150 int r;
2151
2152 assert_return(v, -EINVAL);
2153 assert_return(method, -EINVAL);
2154
2155 if (v->state == VARLINK_DISCONNECTED)
2156 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
2157 if (v->state != VARLINK_IDLE_CLIENT)
2158 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
2159
2160 assert(v->n_pending == 0); /* n_pending can't be > 0 if we are in VARLINK_IDLE_CLIENT state */
2161
2162 /* If there was still a reply pinned from a previous call, now it's the time to get rid of it, so
2163 * that we can assign a new reply shortly. */
2164 varlink_clear_current(v);
2165
2166 r = varlink_bind_reply(v, collect_callback);
2167 if (r < 0)
2168 return varlink_log_errno(v, r, "Failed to bind collect callback");
2169
2170 varlink_set_userdata(v, &context);
2171 r = varlink_observe(v, method, parameters);
2172 if (r < 0)
2173 return varlink_log_errno(v, r, "Failed to collect varlink method: %m");
2174
2175 while (v->state == VARLINK_AWAITING_REPLY_MORE) {
2176
2177 r = varlink_process(v);
2178 if (r < 0)
2179 return r;
2180
2181 /* If we get an error from any of the replies, return immediately with just the error_id and flags*/
2182 if (context.error_id) {
2183 if (ret_error_id)
2184 *ret_error_id = TAKE_PTR(context.error_id);
2185 if (ret_flags)
2186 *ret_flags = context.flags;
2187 return 0;
2188 }
2189
2190 if (r > 0)
2191 continue;
2192
2193 r = varlink_wait(v, USEC_INFINITY);
2194 if (r < 0)
2195 return r;
2196 }
2197
2198 switch (v->state) {
2199
2200 case VARLINK_IDLE_CLIENT:
2201 break;
2202
2203 case VARLINK_PENDING_DISCONNECT:
2204 case VARLINK_DISCONNECTED:
2205 return varlink_log_errno(v, SYNTHETIC_ERRNO(ECONNRESET), "Connection was closed.");
2206
2207 case VARLINK_PENDING_TIMEOUT:
2208 return varlink_log_errno(v, SYNTHETIC_ERRNO(ETIME), "Connection timed out.");
2209
2210 default:
2211 assert_not_reached();
2212 }
2213
2214 if (ret_parameters)
2215 *ret_parameters = TAKE_PTR(context.parameters);
2216 if (ret_error_id)
2217 *ret_error_id = TAKE_PTR(context.error_id);
2218 if (ret_flags)
2219 *ret_flags = context.flags;
2220 return 1;
2221 }
2222
2223 int varlink_collectb(
2224 Varlink *v,
2225 const char *method,
2226 JsonVariant **ret_parameters,
2227 const char **ret_error_id,
2228 VarlinkReplyFlags *ret_flags, ...) {
2229
2230 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
2231 va_list ap;
2232 int r;
2233
2234 assert_return(v, -EINVAL);
2235
2236 va_start(ap, ret_flags);
2237 r = json_buildv(&parameters, ap);
2238 va_end(ap);
2239
2240 if (r < 0)
2241 return varlink_log_errno(v, r, "Failed to build json message: %m");
2242
2243 return varlink_collect(v, method, parameters, ret_parameters, ret_error_id, ret_flags);
2244 }
2245
2246 int varlink_reply(Varlink *v, JsonVariant *parameters) {
2247 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
2248 int r;
2249
2250 assert_return(v, -EINVAL);
2251
2252 if (v->state == VARLINK_DISCONNECTED)
2253 return -ENOTCONN;
2254 if (!IN_SET(v->state,
2255 VARLINK_PROCESSING_METHOD, VARLINK_PROCESSING_METHOD_MORE,
2256 VARLINK_PENDING_METHOD, VARLINK_PENDING_METHOD_MORE))
2257 return -EBUSY;
2258
2259 r = varlink_sanitize_parameters(&parameters);
2260 if (r < 0)
2261 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
2262
2263 r = json_build(&m, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters))));
2264 if (r < 0)
2265 return varlink_log_errno(v, r, "Failed to build json message: %m");
2266
2267 if (v->current_method) {
2268 const char *bad_field = NULL;
2269
2270 r = varlink_idl_validate_method_reply(v->current_method, parameters, &bad_field);
2271 if (r < 0)
2272 varlink_log_errno(v, r, "Return parameters for method reply %s() didn't pass validation on field '%s', ignoring: %m", v->current_method->name, strna(bad_field));
2273 }
2274
2275 r = varlink_enqueue_json(v, m);
2276 if (r < 0)
2277 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
2278
2279 if (IN_SET(v->state, VARLINK_PENDING_METHOD, VARLINK_PENDING_METHOD_MORE)) {
2280 /* We just replied to a method call that was let hanging for a while (i.e. we were outside of
2281 * the varlink_dispatch_method() stack frame), which means with this reply we are ready to
2282 * process further messages. */
2283 varlink_clear_current(v);
2284 varlink_set_state(v, VARLINK_IDLE_SERVER);
2285 } else
2286 /* We replied to a method call from within the varlink_dispatch_method() stack frame), which
2287 * means we should it handle the rest of the state engine. */
2288 varlink_set_state(v, VARLINK_PROCESSED_METHOD);
2289
2290 return 1;
2291 }
2292
2293 int varlink_replyb(Varlink *v, ...) {
2294 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
2295 va_list ap;
2296 int r;
2297
2298 assert_return(v, -EINVAL);
2299
2300 va_start(ap, v);
2301 r = json_buildv(&parameters, ap);
2302 va_end(ap);
2303
2304 if (r < 0)
2305 return r;
2306
2307 return varlink_reply(v, parameters);
2308 }
2309
2310 int varlink_error(Varlink *v, const char *error_id, JsonVariant *parameters) {
2311 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
2312 int r;
2313
2314 assert_return(v, -EINVAL);
2315 assert_return(error_id, -EINVAL);
2316
2317 if (v->state == VARLINK_DISCONNECTED)
2318 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
2319 if (!IN_SET(v->state,
2320 VARLINK_PROCESSING_METHOD, VARLINK_PROCESSING_METHOD_MORE,
2321 VARLINK_PENDING_METHOD, VARLINK_PENDING_METHOD_MORE))
2322 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
2323
2324 /* Reset the list of pushed file descriptors before sending an error reply. We do this here to
2325 * simplify code that puts together a complex reply message with fds, and half-way something
2326 * fails. In that case the pushed fds need to be flushed out again. Under the assumption that it
2327 * never makes sense to send fds along with errors we simply flush them out here beforehand, so that
2328 * the callers don't need to do this explicitly. */
2329 varlink_reset_fds(v);
2330
2331 r = varlink_sanitize_parameters(&parameters);
2332 if (r < 0)
2333 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
2334
2335 r = json_build(&m, JSON_BUILD_OBJECT(
2336 JSON_BUILD_PAIR("error", JSON_BUILD_STRING(error_id)),
2337 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters))));
2338 if (r < 0)
2339 return varlink_log_errno(v, r, "Failed to build json message: %m");
2340
2341 VarlinkSymbol *symbol = hashmap_get(v->server->symbols, error_id);
2342 if (!symbol)
2343 varlink_log(v, "No interface description defined for error '%s', not validating.", error_id);
2344 else {
2345 const char *bad_field = NULL;
2346
2347 r = varlink_idl_validate_error(symbol, parameters, &bad_field);
2348 if (r < 0)
2349 varlink_log_errno(v, r, "Parameters for error %s didn't pass validation on field '%s', ignoring: %m", error_id, strna(bad_field));
2350 }
2351
2352 r = varlink_enqueue_json(v, m);
2353 if (r < 0)
2354 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
2355
2356 if (IN_SET(v->state, VARLINK_PENDING_METHOD, VARLINK_PENDING_METHOD_MORE)) {
2357 varlink_clear_current(v);
2358 varlink_set_state(v, VARLINK_IDLE_SERVER);
2359 } else
2360 varlink_set_state(v, VARLINK_PROCESSED_METHOD);
2361
2362 return 1;
2363 }
2364
2365 int varlink_errorb(Varlink *v, const char *error_id, ...) {
2366 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
2367 va_list ap;
2368 int r;
2369
2370 assert_return(v, -EINVAL);
2371 assert_return(error_id, -EINVAL);
2372
2373 va_start(ap, error_id);
2374 r = json_buildv(&parameters, ap);
2375 va_end(ap);
2376
2377 if (r < 0)
2378 return varlink_log_errno(v, r, "Failed to build json message: %m");
2379
2380 return varlink_error(v, error_id, parameters);
2381 }
2382
2383 int varlink_error_invalid_parameter(Varlink *v, JsonVariant *parameters) {
2384 int r;
2385
2386 assert_return(v, -EINVAL);
2387 assert_return(parameters, -EINVAL);
2388
2389 /* We expect to be called in one of two ways: the 'parameters' argument is a string variant in which
2390 * case it is the parameter key name that is invalid. Or the 'parameters' argument is an object
2391 * variant in which case we'll pull out the first key. The latter mode is useful in functions that
2392 * don't expect any arguments. */
2393
2394 /* varlink_error(...) expects a json object as the third parameter. Passing a string variant causes
2395 * parameter sanitization to fail, and it returns -EINVAL. */
2396
2397 if (json_variant_is_string(parameters)) {
2398 _cleanup_(json_variant_unrefp) JsonVariant *parameters_obj = NULL;
2399
2400 r = json_build(&parameters_obj,
2401 JSON_BUILD_OBJECT(
2402 JSON_BUILD_PAIR("parameter", JSON_BUILD_VARIANT(parameters))));
2403 if (r < 0)
2404 return r;
2405
2406 return varlink_error(v, VARLINK_ERROR_INVALID_PARAMETER, parameters_obj);
2407 }
2408
2409 if (json_variant_is_object(parameters) &&
2410 json_variant_elements(parameters) > 0) {
2411 _cleanup_(json_variant_unrefp) JsonVariant *parameters_obj = NULL;
2412
2413 r = json_build(&parameters_obj,
2414 JSON_BUILD_OBJECT(
2415 JSON_BUILD_PAIR("parameter", JSON_BUILD_VARIANT(json_variant_by_index(parameters, 0)))));
2416 if (r < 0)
2417 return r;
2418
2419 return varlink_error(v, VARLINK_ERROR_INVALID_PARAMETER, parameters_obj);
2420 }
2421
2422 return -EINVAL;
2423 }
2424
2425 int varlink_error_errno(Varlink *v, int error) {
2426 return varlink_errorb(
2427 v,
2428 VARLINK_ERROR_SYSTEM,
2429 JSON_BUILD_OBJECT(JSON_BUILD_PAIR("errno", JSON_BUILD_INTEGER(abs(error)))));
2430 }
2431
2432 int varlink_notify(Varlink *v, JsonVariant *parameters) {
2433 _cleanup_(json_variant_unrefp) JsonVariant *m = NULL;
2434 int r;
2435
2436 assert_return(v, -EINVAL);
2437
2438 if (v->state == VARLINK_DISCONNECTED)
2439 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENOTCONN), "Not connected.");
2440
2441 /* If we want to reply with a notify connection but the caller didn't set "more", then return an
2442 * error indicating that we expected to be called with "more" set */
2443 if (IN_SET(v->state, VARLINK_PROCESSING_METHOD, VARLINK_PENDING_METHOD))
2444 return varlink_error(v, VARLINK_ERROR_EXPECTED_MORE, NULL);
2445
2446 if (!IN_SET(v->state, VARLINK_PROCESSING_METHOD_MORE, VARLINK_PENDING_METHOD_MORE))
2447 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "Connection busy.");
2448
2449 r = varlink_sanitize_parameters(&parameters);
2450 if (r < 0)
2451 return varlink_log_errno(v, r, "Failed to sanitize parameters: %m");
2452
2453 r = json_build(&m, JSON_BUILD_OBJECT(
2454 JSON_BUILD_PAIR("parameters", JSON_BUILD_VARIANT(parameters)),
2455 JSON_BUILD_PAIR("continues", JSON_BUILD_BOOLEAN(true))));
2456 if (r < 0)
2457 return varlink_log_errno(v, r, "Failed to build json message: %m");
2458
2459 if (v->current_method) {
2460 const char *bad_field = NULL;
2461
2462 r = varlink_idl_validate_method_reply(v->current_method, parameters, &bad_field);
2463 if (r < 0)
2464 varlink_log_errno(v, r, "Return parameters for method reply %s() didn't pass validation on field '%s', ignoring: %m", v->current_method->name, strna(bad_field));
2465 }
2466
2467 r = varlink_enqueue_json(v, m);
2468 if (r < 0)
2469 return varlink_log_errno(v, r, "Failed to enqueue json message: %m");
2470
2471 /* No state change, as more is coming */
2472 return 1;
2473 }
2474
2475 int varlink_notifyb(Varlink *v, ...) {
2476 _cleanup_(json_variant_unrefp) JsonVariant *parameters = NULL;
2477 va_list ap;
2478 int r;
2479
2480 assert_return(v, -EINVAL);
2481
2482 va_start(ap, v);
2483 r = json_buildv(&parameters, ap);
2484 va_end(ap);
2485
2486 if (r < 0)
2487 return varlink_log_errno(v, r, "Failed to build json message: %m");
2488
2489 return varlink_notify(v, parameters);
2490 }
2491
2492 int varlink_dispatch(Varlink *v, JsonVariant *parameters, const JsonDispatch table[], void *userdata) {
2493 const char *bad_field = NULL;
2494 int r;
2495
2496 assert_return(v, -EINVAL);
2497 assert_return(table, -EINVAL);
2498
2499 /* A wrapper around json_dispatch_full() that returns a nice InvalidParameter error if we hit a problem with some field. */
2500
2501 r = json_dispatch_full(parameters, table, /* bad= */ NULL, /* flags= */ 0, userdata, &bad_field);
2502 if (r < 0) {
2503 if (bad_field)
2504 return varlink_errorb(v, VARLINK_ERROR_INVALID_PARAMETER,
2505 JSON_BUILD_OBJECT(JSON_BUILD_PAIR("parameter", JSON_BUILD_STRING(bad_field))));
2506 return r;
2507 }
2508
2509 return 0;
2510 }
2511
2512 int varlink_bind_reply(Varlink *v, VarlinkReply callback) {
2513 assert_return(v, -EINVAL);
2514
2515 if (callback && v->reply_callback && callback != v->reply_callback)
2516 return varlink_log_errno(v, SYNTHETIC_ERRNO(EBUSY), "A different callback was already set.");
2517
2518 v->reply_callback = callback;
2519
2520 return 0;
2521 }
2522
2523 void* varlink_set_userdata(Varlink *v, void *userdata) {
2524 void *old;
2525
2526 assert_return(v, NULL);
2527
2528 old = v->userdata;
2529 v->userdata = userdata;
2530
2531 return old;
2532 }
2533
2534 void* varlink_get_userdata(Varlink *v) {
2535 assert_return(v, NULL);
2536
2537 return v->userdata;
2538 }
2539
2540 static int varlink_acquire_ucred(Varlink *v) {
2541 int r;
2542
2543 assert(v);
2544
2545 if (v->ucred_acquired)
2546 return 0;
2547
2548 r = getpeercred(v->fd, &v->ucred);
2549 if (r < 0)
2550 return r;
2551
2552 v->ucred_acquired = true;
2553 return 0;
2554 }
2555
2556 int varlink_get_peer_uid(Varlink *v, uid_t *ret) {
2557 int r;
2558
2559 assert_return(v, -EINVAL);
2560 assert_return(ret, -EINVAL);
2561
2562 r = varlink_acquire_ucred(v);
2563 if (r < 0)
2564 return varlink_log_errno(v, r, "Failed to acquire credentials: %m");
2565
2566 if (!uid_is_valid(v->ucred.uid))
2567 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENODATA), "Peer uid is invalid.");
2568
2569 *ret = v->ucred.uid;
2570 return 0;
2571 }
2572
2573 int varlink_get_peer_pid(Varlink *v, pid_t *ret) {
2574 int r;
2575
2576 assert_return(v, -EINVAL);
2577 assert_return(ret, -EINVAL);
2578
2579 r = varlink_acquire_ucred(v);
2580 if (r < 0)
2581 return varlink_log_errno(v, r, "Failed to acquire credentials: %m");
2582
2583 if (!pid_is_valid(v->ucred.pid))
2584 return varlink_log_errno(v, SYNTHETIC_ERRNO(ENODATA), "Peer uid is invalid.");
2585
2586 *ret = v->ucred.pid;
2587 return 0;
2588 }
2589
2590 int varlink_set_relative_timeout(Varlink *v, usec_t timeout) {
2591 assert_return(v, -EINVAL);
2592 assert_return(timeout > 0, -EINVAL);
2593
2594 v->timeout = timeout;
2595 return 0;
2596 }
2597
2598 VarlinkServer *varlink_get_server(Varlink *v) {
2599 assert_return(v, NULL);
2600
2601 return v->server;
2602 }
2603
2604 int varlink_set_description(Varlink *v, const char *description) {
2605 assert_return(v, -EINVAL);
2606
2607 return free_and_strdup(&v->description, description);
2608 }
2609
2610 static int io_callback(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
2611 Varlink *v = ASSERT_PTR(userdata);
2612
2613 assert(s);
2614
2615 handle_revents(v, revents);
2616 (void) varlink_process(v);
2617
2618 return 1;
2619 }
2620
2621 static int time_callback(sd_event_source *s, uint64_t usec, void *userdata) {
2622 Varlink *v = ASSERT_PTR(userdata);
2623
2624 assert(s);
2625
2626 (void) varlink_process(v);
2627 return 1;
2628 }
2629
2630 static int defer_callback(sd_event_source *s, void *userdata) {
2631 Varlink *v = ASSERT_PTR(userdata);
2632
2633 assert(s);
2634
2635 (void) varlink_process(v);
2636 return 1;
2637 }
2638
2639 static int prepare_callback(sd_event_source *s, void *userdata) {
2640 Varlink *v = ASSERT_PTR(userdata);
2641 int r, e;
2642 usec_t until;
2643 bool have_timeout;
2644
2645 assert(s);
2646
2647 e = varlink_get_events(v);
2648 if (e < 0)
2649 return e;
2650
2651 r = sd_event_source_set_io_events(v->io_event_source, e);
2652 if (r < 0)
2653 return varlink_log_errno(v, r, "Failed to set source events: %m");
2654
2655 r = varlink_get_timeout(v, &until);
2656 if (r < 0)
2657 return r;
2658 have_timeout = r > 0;
2659
2660 if (have_timeout) {
2661 r = sd_event_source_set_time(v->time_event_source, until);
2662 if (r < 0)
2663 return varlink_log_errno(v, r, "Failed to set source time: %m");
2664 }
2665
2666 r = sd_event_source_set_enabled(v->time_event_source, have_timeout ? SD_EVENT_ON : SD_EVENT_OFF);
2667 if (r < 0)
2668 return varlink_log_errno(v, r, "Failed to enable event source: %m");
2669
2670 return 1;
2671 }
2672
2673 static int quit_callback(sd_event_source *event, void *userdata) {
2674 Varlink *v = ASSERT_PTR(userdata);
2675
2676 assert(event);
2677
2678 varlink_flush(v);
2679 varlink_close(v);
2680
2681 return 1;
2682 }
2683
2684 int varlink_attach_event(Varlink *v, sd_event *e, int64_t priority) {
2685 int r;
2686
2687 assert_return(v, -EINVAL);
2688 assert_return(!v->event, -EBUSY);
2689
2690 if (e)
2691 v->event = sd_event_ref(e);
2692 else {
2693 r = sd_event_default(&v->event);
2694 if (r < 0)
2695 return varlink_log_errno(v, r, "Failed to create event source: %m");
2696 }
2697
2698 r = sd_event_add_time(v->event, &v->time_event_source, CLOCK_MONOTONIC, 0, 0, time_callback, v);
2699 if (r < 0)
2700 goto fail;
2701
2702 r = sd_event_source_set_priority(v->time_event_source, priority);
2703 if (r < 0)
2704 goto fail;
2705
2706 (void) sd_event_source_set_description(v->time_event_source, "varlink-time");
2707
2708 r = sd_event_add_exit(v->event, &v->quit_event_source, quit_callback, v);
2709 if (r < 0)
2710 goto fail;
2711
2712 r = sd_event_source_set_priority(v->quit_event_source, priority);
2713 if (r < 0)
2714 goto fail;
2715
2716 (void) sd_event_source_set_description(v->quit_event_source, "varlink-quit");
2717
2718 r = sd_event_add_io(v->event, &v->io_event_source, v->fd, 0, io_callback, v);
2719 if (r < 0)
2720 goto fail;
2721
2722 r = sd_event_source_set_prepare(v->io_event_source, prepare_callback);
2723 if (r < 0)
2724 goto fail;
2725
2726 r = sd_event_source_set_priority(v->io_event_source, priority);
2727 if (r < 0)
2728 goto fail;
2729
2730 (void) sd_event_source_set_description(v->io_event_source, "varlink-io");
2731
2732 r = sd_event_add_defer(v->event, &v->defer_event_source, defer_callback, v);
2733 if (r < 0)
2734 goto fail;
2735
2736 r = sd_event_source_set_priority(v->defer_event_source, priority);
2737 if (r < 0)
2738 goto fail;
2739
2740 (void) sd_event_source_set_description(v->defer_event_source, "varlink-defer");
2741
2742 return 0;
2743
2744 fail:
2745 varlink_log_errno(v, r, "Failed to setup event source: %m");
2746 varlink_detach_event(v);
2747 return r;
2748 }
2749
2750 void varlink_detach_event(Varlink *v) {
2751 if (!v)
2752 return;
2753
2754 varlink_detach_event_sources(v);
2755
2756 v->event = sd_event_unref(v->event);
2757 }
2758
2759 sd_event *varlink_get_event(Varlink *v) {
2760 assert_return(v, NULL);
2761
2762 return v->event;
2763 }
2764
2765 int varlink_push_fd(Varlink *v, int fd) {
2766 int i;
2767
2768 assert_return(v, -EINVAL);
2769 assert_return(fd >= 0, -EBADF);
2770
2771 /* Takes an fd to send along with the *next* varlink message sent via this varlink connection. This
2772 * takes ownership of the specified fd. Use varlink_dup_fd() below to duplicate the fd first. */
2773
2774 if (!v->allow_fd_passing_output)
2775 return -EPERM;
2776
2777 if (v->n_pushed_fds >= INT_MAX)
2778 return -ENOMEM;
2779
2780 if (!GREEDY_REALLOC(v->pushed_fds, v->n_pushed_fds + 1))
2781 return -ENOMEM;
2782
2783 i = (int) v->n_pushed_fds;
2784 v->pushed_fds[v->n_pushed_fds++] = fd;
2785 return i;
2786 }
2787
2788 int varlink_dup_fd(Varlink *v, int fd) {
2789 _cleanup_close_ int dp = -1;
2790 int r;
2791
2792 assert_return(v, -EINVAL);
2793 assert_return(fd >= 0, -EBADF);
2794
2795 /* Like varlink_push_fd() but duplicates the specified fd instead of taking possession of it */
2796
2797 dp = fcntl(fd, F_DUPFD_CLOEXEC, 3);
2798 if (dp < 0)
2799 return -errno;
2800
2801 r = varlink_push_fd(v, dp);
2802 if (r < 0)
2803 return r;
2804
2805 TAKE_FD(dp);
2806 return r;
2807 }
2808
2809 int varlink_reset_fds(Varlink *v) {
2810 assert_return(v, -EINVAL);
2811
2812 /* Closes all currently pending fds to send. This may be used whenever the caller is in the process
2813 * of putting together a message with fds, and then eventually something fails and they need to
2814 * rollback the fds. Note that this is implicitly called whenever an error reply is sent, see above. */
2815
2816 close_many(v->output_fds, v->n_output_fds);
2817 v->n_output_fds = 0;
2818 return 0;
2819 }
2820
2821 int varlink_peek_fd(Varlink *v, size_t i) {
2822 assert_return(v, -EINVAL);
2823
2824 /* Returns one of the file descriptors that were received along with the current message. This does
2825 * not duplicate the fd nor invalidate it, it hence remains in our possession. */
2826
2827 if (!v->allow_fd_passing_input)
2828 return -EPERM;
2829
2830 if (i >= v->n_input_fds)
2831 return -ENXIO;
2832
2833 return v->input_fds[i];
2834 }
2835
2836 int varlink_take_fd(Varlink *v, size_t i) {
2837 assert_return(v, -EINVAL);
2838
2839 /* Similar to varlink_peek_fd() but the file descriptor's ownership is passed to the caller, and
2840 * we'll invalidate the reference to it under our possession. If called twice in a row will return
2841 * -EBADF */
2842
2843 if (!v->allow_fd_passing_input)
2844 return -EPERM;
2845
2846 if (i >= v->n_input_fds)
2847 return -ENXIO;
2848
2849 return TAKE_FD(v->input_fds[i]);
2850 }
2851
2852 static int verify_unix_socket(Varlink *v) {
2853 assert(v);
2854
2855 if (v->af < 0) {
2856 struct stat st;
2857
2858 if (fstat(v->fd, &st) < 0)
2859 return -errno;
2860 if (!S_ISSOCK(st.st_mode)) {
2861 v->af = AF_UNSPEC;
2862 return -ENOTSOCK;
2863 }
2864
2865 v->af = socket_get_family(v->fd);
2866 if (v->af < 0)
2867 return v->af;
2868 }
2869
2870 return v->af == AF_UNIX ? 0 : -ENOMEDIUM;
2871 }
2872
2873 int varlink_set_allow_fd_passing_input(Varlink *v, bool b) {
2874 int r;
2875
2876 assert_return(v, -EINVAL);
2877
2878 if (v->allow_fd_passing_input == b)
2879 return 0;
2880
2881 if (!b) {
2882 v->allow_fd_passing_input = false;
2883 return 1;
2884 }
2885
2886 r = verify_unix_socket(v);
2887 if (r < 0)
2888 return r;
2889
2890 v->allow_fd_passing_input = true;
2891 return 0;
2892 }
2893
2894 int varlink_set_allow_fd_passing_output(Varlink *v, bool b) {
2895 int r;
2896
2897 assert_return(v, -EINVAL);
2898
2899 if (v->allow_fd_passing_output == b)
2900 return 0;
2901
2902 if (!b) {
2903 v->allow_fd_passing_output = false;
2904 return 1;
2905 }
2906
2907 r = verify_unix_socket(v);
2908 if (r < 0)
2909 return r;
2910
2911 v->allow_fd_passing_output = true;
2912 return 0;
2913 }
2914
2915 int varlink_server_new(VarlinkServer **ret, VarlinkServerFlags flags) {
2916 _cleanup_(varlink_server_unrefp) VarlinkServer *s = NULL;
2917 int r;
2918
2919 assert_return(ret, -EINVAL);
2920 assert_return((flags & ~_VARLINK_SERVER_FLAGS_ALL) == 0, -EINVAL);
2921
2922 s = new(VarlinkServer, 1);
2923 if (!s)
2924 return log_oom_debug();
2925
2926 *s = (VarlinkServer) {
2927 .n_ref = 1,
2928 .flags = flags,
2929 .connections_max = varlink_server_connections_max(NULL),
2930 .connections_per_uid_max = varlink_server_connections_per_uid_max(NULL),
2931 };
2932
2933 r = varlink_server_add_interface_many(
2934 s,
2935 &vl_interface_io_systemd,
2936 &vl_interface_org_varlink_service);
2937 if (r < 0)
2938 return r;
2939
2940 *ret = TAKE_PTR(s);
2941 return 0;
2942 }
2943
2944 static VarlinkServer* varlink_server_destroy(VarlinkServer *s) {
2945 char *m;
2946
2947 if (!s)
2948 return NULL;
2949
2950 varlink_server_shutdown(s);
2951
2952 while ((m = hashmap_steal_first_key(s->methods)))
2953 free(m);
2954
2955 hashmap_free(s->methods);
2956 hashmap_free(s->interfaces);
2957 hashmap_free(s->symbols);
2958 hashmap_free(s->by_uid);
2959
2960 sd_event_unref(s->event);
2961
2962 free(s->description);
2963
2964 return mfree(s);
2965 }
2966
2967 DEFINE_TRIVIAL_REF_UNREF_FUNC(VarlinkServer, varlink_server, varlink_server_destroy);
2968
2969 static int validate_connection(VarlinkServer *server, const struct ucred *ucred) {
2970 int allowed = -1;
2971
2972 assert(server);
2973 assert(ucred);
2974
2975 if (FLAGS_SET(server->flags, VARLINK_SERVER_ROOT_ONLY))
2976 allowed = ucred->uid == 0;
2977
2978 if (FLAGS_SET(server->flags, VARLINK_SERVER_MYSELF_ONLY))
2979 allowed = allowed > 0 || ucred->uid == getuid();
2980
2981 if (allowed == 0) { /* Allow access when it is explicitly allowed or when neither
2982 * VARLINK_SERVER_ROOT_ONLY nor VARLINK_SERVER_MYSELF_ONLY are specified. */
2983 varlink_server_log(server, "Unprivileged client attempted connection, refusing.");
2984 return 0;
2985 }
2986
2987 if (server->n_connections >= server->connections_max) {
2988 varlink_server_log(server, "Connection limit of %u reached, refusing.", server->connections_max);
2989 return 0;
2990 }
2991
2992 if (FLAGS_SET(server->flags, VARLINK_SERVER_ACCOUNT_UID)) {
2993 unsigned c;
2994
2995 if (!uid_is_valid(ucred->uid)) {
2996 varlink_server_log(server, "Client with invalid UID attempted connection, refusing.");
2997 return 0;
2998 }
2999
3000 c = PTR_TO_UINT(hashmap_get(server->by_uid, UID_TO_PTR(ucred->uid)));
3001 if (c >= server->connections_per_uid_max) {
3002 varlink_server_log(server, "Per-UID connection limit of %u reached, refusing.",
3003 server->connections_per_uid_max);
3004 return 0;
3005 }
3006 }
3007
3008 return 1;
3009 }
3010
3011 static int count_connection(VarlinkServer *server, const struct ucred *ucred) {
3012 unsigned c;
3013 int r;
3014
3015 assert(server);
3016 assert(ucred);
3017
3018 server->n_connections++;
3019
3020 if (FLAGS_SET(server->flags, VARLINK_SERVER_ACCOUNT_UID)) {
3021 assert(uid_is_valid(ucred->uid));
3022
3023 r = hashmap_ensure_allocated(&server->by_uid, NULL);
3024 if (r < 0)
3025 return varlink_server_log_errno(server, r, "Failed to allocate UID hash table: %m");
3026
3027 c = PTR_TO_UINT(hashmap_get(server->by_uid, UID_TO_PTR(ucred->uid)));
3028
3029 varlink_server_log(server, "Connections of user " UID_FMT ": %u (of %u max)",
3030 ucred->uid, c, server->connections_per_uid_max);
3031
3032 r = hashmap_replace(server->by_uid, UID_TO_PTR(ucred->uid), UINT_TO_PTR(c + 1));
3033 if (r < 0)
3034 return varlink_server_log_errno(server, r, "Failed to increment counter in UID hash table: %m");
3035 }
3036
3037 return 0;
3038 }
3039
3040 int varlink_server_add_connection(VarlinkServer *server, int fd, Varlink **ret) {
3041 _cleanup_(varlink_unrefp) Varlink *v = NULL;
3042 struct ucred ucred = UCRED_INVALID;
3043 bool ucred_acquired;
3044 int r;
3045
3046 assert_return(server, -EINVAL);
3047 assert_return(fd >= 0, -EBADF);
3048
3049 if ((server->flags & (VARLINK_SERVER_ROOT_ONLY|VARLINK_SERVER_ACCOUNT_UID)) != 0) {
3050 r = getpeercred(fd, &ucred);
3051 if (r < 0)
3052 return varlink_server_log_errno(server, r, "Failed to acquire peer credentials of incoming socket, refusing: %m");
3053
3054 ucred_acquired = true;
3055
3056 r = validate_connection(server, &ucred);
3057 if (r < 0)
3058 return r;
3059 if (r == 0)
3060 return -EPERM;
3061 } else
3062 ucred_acquired = false;
3063
3064 r = varlink_new(&v);
3065 if (r < 0)
3066 return varlink_server_log_errno(server, r, "Failed to allocate connection object: %m");
3067
3068 r = count_connection(server, &ucred);
3069 if (r < 0)
3070 return r;
3071
3072 v->fd = fd;
3073 if (server->flags & VARLINK_SERVER_INHERIT_USERDATA)
3074 v->userdata = server->userdata;
3075
3076 if (ucred_acquired) {
3077 v->ucred = ucred;
3078 v->ucred_acquired = true;
3079 }
3080
3081 _cleanup_free_ char *desc = NULL;
3082 if (asprintf(&desc, "%s-%i", server->description ?: "varlink", v->fd) >= 0)
3083 v->description = TAKE_PTR(desc);
3084
3085 /* Link up the server and the connection, and take reference in both directions. Note that the
3086 * reference on the connection is left dangling. It will be dropped when the connection is closed,
3087 * which happens in varlink_close(), including in the event loop quit callback. */
3088 v->server = varlink_server_ref(server);
3089 varlink_ref(v);
3090
3091 varlink_set_state(v, VARLINK_IDLE_SERVER);
3092
3093 if (server->event) {
3094 r = varlink_attach_event(v, server->event, server->event_priority);
3095 if (r < 0) {
3096 varlink_log_errno(v, r, "Failed to attach new connection: %m");
3097 v->fd = -EBADF; /* take the fd out of the connection again */
3098 varlink_close(v);
3099 return r;
3100 }
3101 }
3102
3103 if (ret)
3104 *ret = v;
3105
3106 return 0;
3107 }
3108
3109 static VarlinkServerSocket *varlink_server_socket_free(VarlinkServerSocket *ss) {
3110 if (!ss)
3111 return NULL;
3112
3113 free(ss->address);
3114 return mfree(ss);
3115 }
3116
3117 DEFINE_TRIVIAL_CLEANUP_FUNC(VarlinkServerSocket *, varlink_server_socket_free);
3118
3119 static int connect_callback(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
3120 VarlinkServerSocket *ss = ASSERT_PTR(userdata);
3121 _cleanup_close_ int cfd = -EBADF;
3122 Varlink *v = NULL;
3123 int r;
3124
3125 assert(source);
3126
3127 varlink_server_log(ss->server, "New incoming connection.");
3128
3129 cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK|SOCK_CLOEXEC);
3130 if (cfd < 0) {
3131 if (ERRNO_IS_ACCEPT_AGAIN(errno))
3132 return 0;
3133
3134 return varlink_server_log_errno(ss->server, errno, "Failed to accept incoming socket: %m");
3135 }
3136
3137 r = varlink_server_add_connection(ss->server, cfd, &v);
3138 if (r < 0)
3139 return 0;
3140
3141 TAKE_FD(cfd);
3142
3143 if (ss->server->connect_callback) {
3144 r = ss->server->connect_callback(ss->server, v, ss->server->userdata);
3145 if (r < 0) {
3146 varlink_log_errno(v, r, "Connection callback returned error, disconnecting client: %m");
3147 varlink_close(v);
3148 return 0;
3149 }
3150 }
3151
3152 return 0;
3153 }
3154
3155 static int varlink_server_create_listen_fd_socket(VarlinkServer *s, int fd, VarlinkServerSocket **ret_ss) {
3156 _cleanup_(varlink_server_socket_freep) VarlinkServerSocket *ss = NULL;
3157 int r;
3158
3159 assert(s);
3160 assert(fd >= 0);
3161 assert(ret_ss);
3162
3163 ss = new(VarlinkServerSocket, 1);
3164 if (!ss)
3165 return log_oom_debug();
3166
3167 *ss = (VarlinkServerSocket) {
3168 .server = s,
3169 .fd = fd,
3170 };
3171
3172 if (s->event) {
3173 r = sd_event_add_io(s->event, &ss->event_source, fd, EPOLLIN, connect_callback, ss);
3174 if (r < 0)
3175 return r;
3176
3177 r = sd_event_source_set_priority(ss->event_source, s->event_priority);
3178 if (r < 0)
3179 return r;
3180 }
3181
3182 *ret_ss = TAKE_PTR(ss);
3183 return 0;
3184 }
3185
3186 int varlink_server_listen_fd(VarlinkServer *s, int fd) {
3187 _cleanup_(varlink_server_socket_freep) VarlinkServerSocket *ss = NULL;
3188 int r;
3189
3190 assert_return(s, -EINVAL);
3191 assert_return(fd >= 0, -EBADF);
3192
3193 r = fd_nonblock(fd, true);
3194 if (r < 0)
3195 return r;
3196
3197 r = fd_cloexec(fd, true);
3198 if (r < 0)
3199 return r;
3200
3201 r = varlink_server_create_listen_fd_socket(s, fd, &ss);
3202 if (r < 0)
3203 return r;
3204
3205 LIST_PREPEND(sockets, s->sockets, TAKE_PTR(ss));
3206 return 0;
3207 }
3208
3209 int varlink_server_listen_address(VarlinkServer *s, const char *address, mode_t m) {
3210 _cleanup_(varlink_server_socket_freep) VarlinkServerSocket *ss = NULL;
3211 union sockaddr_union sockaddr;
3212 socklen_t sockaddr_len;
3213 _cleanup_close_ int fd = -EBADF;
3214 int r;
3215
3216 assert_return(s, -EINVAL);
3217 assert_return(address, -EINVAL);
3218 assert_return((m & ~0777) == 0, -EINVAL);
3219
3220 r = sockaddr_un_set_path(&sockaddr.un, address);
3221 if (r < 0)
3222 return r;
3223 sockaddr_len = r;
3224
3225 fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
3226 if (fd < 0)
3227 return -errno;
3228
3229 fd = fd_move_above_stdio(fd);
3230
3231 (void) sockaddr_un_unlink(&sockaddr.un);
3232
3233 WITH_UMASK(~m & 0777) {
3234 r = mac_selinux_bind(fd, &sockaddr.sa, sockaddr_len);
3235 if (r < 0)
3236 return r;
3237 }
3238
3239 if (listen(fd, SOMAXCONN_DELUXE) < 0)
3240 return -errno;
3241
3242 r = varlink_server_create_listen_fd_socket(s, fd, &ss);
3243 if (r < 0)
3244 return r;
3245
3246 r = free_and_strdup(&ss->address, address);
3247 if (r < 0)
3248 return r;
3249
3250 LIST_PREPEND(sockets, s->sockets, TAKE_PTR(ss));
3251 TAKE_FD(fd);
3252 return 0;
3253 }
3254
3255 int varlink_server_listen_auto(VarlinkServer *s) {
3256 _cleanup_strv_free_ char **names = NULL;
3257 int r, n = 0;
3258
3259 assert_return(s, -EINVAL);
3260
3261 /* Adds all passed fds marked as "varlink" to our varlink server. These fds can either refer to a
3262 * listening socket or to a connection socket.
3263 *
3264 * See https://varlink.org/#activation for the environment variables this is backed by and the
3265 * recommended "varlink" identifier in $LISTEN_FDNAMES. */
3266
3267 r = sd_listen_fds_with_names(/* unset_environment= */ false, &names);
3268 if (r < 0)
3269 return r;
3270
3271 for (int i = 0; i < r; i++) {
3272 int b, fd;
3273 socklen_t l = sizeof(b);
3274
3275 if (!streq(names[i], "varlink"))
3276 continue;
3277
3278 fd = SD_LISTEN_FDS_START + i;
3279
3280 if (getsockopt(fd, SOL_SOCKET, SO_ACCEPTCONN, &b, &l) < 0)
3281 return -errno;
3282
3283 assert(l == sizeof(b));
3284
3285 if (b) /* Listening socket? */
3286 r = varlink_server_listen_fd(s, fd);
3287 else /* Otherwise assume connection socket */
3288 r = varlink_server_add_connection(s, fd, NULL);
3289 if (r < 0)
3290 return r;
3291
3292 n++;
3293 }
3294
3295 return n;
3296 }
3297
3298 void* varlink_server_set_userdata(VarlinkServer *s, void *userdata) {
3299 void *ret;
3300
3301 assert_return(s, NULL);
3302
3303 ret = s->userdata;
3304 s->userdata = userdata;
3305
3306 return ret;
3307 }
3308
3309 void* varlink_server_get_userdata(VarlinkServer *s) {
3310 assert_return(s, NULL);
3311
3312 return s->userdata;
3313 }
3314
3315 int varlink_server_loop_auto(VarlinkServer *server) {
3316 _cleanup_(sd_event_unrefp) sd_event *event = NULL;
3317 int r;
3318
3319 assert_return(server, -EINVAL);
3320 assert_return(!server->event, -EBUSY);
3321
3322 /* Runs a Varlink service event loop populated with a passed fd. Exits on the last connection. */
3323
3324 r = sd_event_new(&event);
3325 if (r < 0)
3326 return r;
3327
3328 r = varlink_server_set_exit_on_idle(server, true);
3329 if (r < 0)
3330 return r;
3331
3332 r = varlink_server_attach_event(server, event, 0);
3333 if (r < 0)
3334 return r;
3335
3336 r = varlink_server_listen_auto(server);
3337 if (r < 0)
3338 return r;
3339
3340 return sd_event_loop(event);
3341 }
3342
3343 static VarlinkServerSocket* varlink_server_socket_destroy(VarlinkServerSocket *ss) {
3344 if (!ss)
3345 return NULL;
3346
3347 if (ss->server)
3348 LIST_REMOVE(sockets, ss->server->sockets, ss);
3349
3350 sd_event_source_disable_unref(ss->event_source);
3351
3352 free(ss->address);
3353 safe_close(ss->fd);
3354
3355 return mfree(ss);
3356 }
3357
3358 int varlink_server_shutdown(VarlinkServer *s) {
3359 assert_return(s, -EINVAL);
3360
3361 while (s->sockets)
3362 varlink_server_socket_destroy(s->sockets);
3363
3364 return 0;
3365 }
3366
3367 static void varlink_server_test_exit_on_idle(VarlinkServer *s) {
3368 assert(s);
3369
3370 if (s->exit_on_idle && s->event && s->n_connections == 0)
3371 (void) sd_event_exit(s->event, 0);
3372 }
3373
3374 int varlink_server_set_exit_on_idle(VarlinkServer *s, bool b) {
3375 assert_return(s, -EINVAL);
3376
3377 s->exit_on_idle = b;
3378 varlink_server_test_exit_on_idle(s);
3379 return 0;
3380 }
3381
3382 static int varlink_server_add_socket_event_source(VarlinkServer *s, VarlinkServerSocket *ss, int64_t priority) {
3383 _cleanup_(sd_event_source_unrefp) sd_event_source *es = NULL;
3384 int r;
3385
3386 assert(s);
3387 assert(s->event);
3388 assert(ss);
3389 assert(ss->fd >= 0);
3390 assert(!ss->event_source);
3391
3392 r = sd_event_add_io(s->event, &es, ss->fd, EPOLLIN, connect_callback, ss);
3393 if (r < 0)
3394 return r;
3395
3396 r = sd_event_source_set_priority(es, priority);
3397 if (r < 0)
3398 return r;
3399
3400 ss->event_source = TAKE_PTR(es);
3401 return 0;
3402 }
3403
3404 int varlink_server_attach_event(VarlinkServer *s, sd_event *e, int64_t priority) {
3405 int r;
3406
3407 assert_return(s, -EINVAL);
3408 assert_return(!s->event, -EBUSY);
3409
3410 if (e)
3411 s->event = sd_event_ref(e);
3412 else {
3413 r = sd_event_default(&s->event);
3414 if (r < 0)
3415 return r;
3416 }
3417
3418 LIST_FOREACH(sockets, ss, s->sockets) {
3419 r = varlink_server_add_socket_event_source(s, ss, priority);
3420 if (r < 0)
3421 goto fail;
3422 }
3423
3424 s->event_priority = priority;
3425 return 0;
3426
3427 fail:
3428 varlink_server_detach_event(s);
3429 return r;
3430 }
3431
3432 int varlink_server_detach_event(VarlinkServer *s) {
3433 assert_return(s, -EINVAL);
3434
3435 LIST_FOREACH(sockets, ss, s->sockets)
3436 ss->event_source = sd_event_source_disable_unref(ss->event_source);
3437
3438 sd_event_unref(s->event);
3439 return 0;
3440 }
3441
3442 sd_event *varlink_server_get_event(VarlinkServer *s) {
3443 assert_return(s, NULL);
3444
3445 return s->event;
3446 }
3447
3448 static bool varlink_symbol_in_interface(const char *method, const char *interface) {
3449 const char *p;
3450
3451 assert(method);
3452 assert(interface);
3453
3454 p = startswith(method, interface);
3455 if (!p)
3456 return false;
3457
3458 if (*p != '.')
3459 return false;
3460
3461 return !strchr(p+1, '.');
3462 }
3463
3464 int varlink_server_bind_method(VarlinkServer *s, const char *method, VarlinkMethod callback) {
3465 _cleanup_free_ char *m = NULL;
3466 int r;
3467
3468 assert_return(s, -EINVAL);
3469 assert_return(method, -EINVAL);
3470 assert_return(callback, -EINVAL);
3471
3472 if (varlink_symbol_in_interface(method, "org.varlink.service") ||
3473 varlink_symbol_in_interface(method, "io.systemd"))
3474 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EEXIST), "Cannot bind server to '%s'.", method);
3475
3476 m = strdup(method);
3477 if (!m)
3478 return log_oom_debug();
3479
3480 r = hashmap_ensure_put(&s->methods, &string_hash_ops, m, callback);
3481 if (r == -ENOMEM)
3482 return log_oom_debug();
3483 if (r < 0)
3484 return varlink_server_log_errno(s, r, "Failed to register callback: %m");
3485 if (r > 0)
3486 TAKE_PTR(m);
3487
3488 return 0;
3489 }
3490
3491 int varlink_server_bind_method_many_internal(VarlinkServer *s, ...) {
3492 va_list ap;
3493 int r = 0;
3494
3495 assert_return(s, -EINVAL);
3496
3497 va_start(ap, s);
3498 for (;;) {
3499 VarlinkMethod callback;
3500 const char *method;
3501
3502 method = va_arg(ap, const char *);
3503 if (!method)
3504 break;
3505
3506 callback = va_arg(ap, VarlinkMethod);
3507
3508 r = varlink_server_bind_method(s, method, callback);
3509 if (r < 0)
3510 break;
3511 }
3512 va_end(ap);
3513
3514 return r;
3515 }
3516
3517 int varlink_server_bind_connect(VarlinkServer *s, VarlinkConnect callback) {
3518 assert_return(s, -EINVAL);
3519
3520 if (callback && s->connect_callback && callback != s->connect_callback)
3521 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EBUSY), "A different callback was already set.");
3522
3523 s->connect_callback = callback;
3524 return 0;
3525 }
3526
3527 int varlink_server_bind_disconnect(VarlinkServer *s, VarlinkDisconnect callback) {
3528 assert_return(s, -EINVAL);
3529
3530 if (callback && s->disconnect_callback && callback != s->disconnect_callback)
3531 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EBUSY), "A different callback was already set.");
3532
3533 s->disconnect_callback = callback;
3534 return 0;
3535 }
3536
3537 int varlink_server_add_interface(VarlinkServer *s, const VarlinkInterface *interface) {
3538 int r;
3539
3540 assert_return(s, -EINVAL);
3541 assert_return(interface, -EINVAL);
3542 assert_return(interface->name, -EINVAL);
3543
3544 if (hashmap_contains(s->interfaces, interface->name))
3545 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EEXIST), "Duplicate registration of interface '%s'.", interface->name);
3546
3547 r = hashmap_ensure_put(&s->interfaces, &string_hash_ops, interface->name, (void*) interface);
3548 if (r < 0)
3549 return r;
3550
3551 for (const VarlinkSymbol *const*symbol = interface->symbols; *symbol; symbol++) {
3552 _cleanup_free_ char *j = NULL;
3553
3554 /* We only ever want to validate method calls/replies and errors against the interface
3555 * definitions, hence don't bother with the type symbols */
3556 if (!IN_SET((*symbol)->symbol_type, VARLINK_METHOD, VARLINK_ERROR))
3557 continue;
3558
3559 j = strjoin(interface->name, ".", (*symbol)->name);
3560 if (!j)
3561 return -ENOMEM;
3562
3563 r = hashmap_ensure_put(&s->symbols, &string_hash_ops_free, j, (void*) *symbol);
3564 if (r < 0)
3565 return r;
3566
3567 TAKE_PTR(j);
3568 }
3569
3570 return 0;
3571 }
3572
3573 int varlink_server_add_interface_many_internal(VarlinkServer *s, ...) {
3574 va_list ap;
3575 int r = 0;
3576
3577 assert_return(s, -EINVAL);
3578
3579 va_start(ap, s);
3580 for (;;) {
3581 const VarlinkInterface *interface = va_arg(ap, const VarlinkInterface*);
3582 if (!interface)
3583 break;
3584
3585 r = varlink_server_add_interface(s, interface);
3586 if (r < 0)
3587 break;
3588 }
3589 va_end(ap);
3590
3591 return r;
3592 }
3593
3594 unsigned varlink_server_connections_max(VarlinkServer *s) {
3595 int dts;
3596
3597 /* If a server is specified, return the setting for that server, otherwise the default value */
3598 if (s)
3599 return s->connections_max;
3600
3601 dts = getdtablesize();
3602 assert_se(dts > 0);
3603
3604 /* Make sure we never use up more than ¾th of RLIMIT_NOFILE for IPC */
3605 if (VARLINK_DEFAULT_CONNECTIONS_MAX > (unsigned) dts / 4 * 3)
3606 return dts / 4 * 3;
3607
3608 return VARLINK_DEFAULT_CONNECTIONS_MAX;
3609 }
3610
3611 unsigned varlink_server_connections_per_uid_max(VarlinkServer *s) {
3612 unsigned m;
3613
3614 if (s)
3615 return s->connections_per_uid_max;
3616
3617 /* Make sure to never use up more than ¾th of available connections for a single user */
3618 m = varlink_server_connections_max(NULL);
3619 if (VARLINK_DEFAULT_CONNECTIONS_PER_UID_MAX > m)
3620 return m / 4 * 3;
3621
3622 return VARLINK_DEFAULT_CONNECTIONS_PER_UID_MAX;
3623 }
3624
3625 int varlink_server_set_connections_per_uid_max(VarlinkServer *s, unsigned m) {
3626 assert_return(s, -EINVAL);
3627 assert_return(m > 0, -EINVAL);
3628
3629 s->connections_per_uid_max = m;
3630 return 0;
3631 }
3632
3633 int varlink_server_set_connections_max(VarlinkServer *s, unsigned m) {
3634 assert_return(s, -EINVAL);
3635 assert_return(m > 0, -EINVAL);
3636
3637 s->connections_max = m;
3638 return 0;
3639 }
3640
3641 unsigned varlink_server_current_connections(VarlinkServer *s) {
3642 assert_return(s, UINT_MAX);
3643
3644 return s->n_connections;
3645 }
3646
3647 int varlink_server_set_description(VarlinkServer *s, const char *description) {
3648 assert_return(s, -EINVAL);
3649
3650 return free_and_strdup(&s->description, description);
3651 }
3652
3653 int varlink_server_serialize(VarlinkServer *s, FILE *f, FDSet *fds) {
3654 assert(f);
3655 assert(fds);
3656
3657 if (!s)
3658 return 0;
3659
3660 LIST_FOREACH(sockets, ss, s->sockets) {
3661 int copy;
3662
3663 assert(ss->address);
3664 assert(ss->fd >= 0);
3665
3666 fprintf(f, "varlink-server-socket-address=%s", ss->address);
3667
3668 /* If we fail to serialize the fd, it will be considered an error during deserialization */
3669 copy = fdset_put_dup(fds, ss->fd);
3670 if (copy < 0)
3671 return copy;
3672
3673 fprintf(f, " varlink-server-socket-fd=%i", copy);
3674
3675 fputc('\n', f);
3676 }
3677
3678 return 0;
3679 }
3680
3681 int varlink_server_deserialize_one(VarlinkServer *s, const char *value, FDSet *fds) {
3682 _cleanup_(varlink_server_socket_freep) VarlinkServerSocket *ss = NULL;
3683 _cleanup_free_ char *address = NULL;
3684 const char *v = ASSERT_PTR(value);
3685 int r, fd = -EBADF;
3686 char *buf;
3687 size_t n;
3688
3689 assert(s);
3690 assert(fds);
3691
3692 n = strcspn(v, " ");
3693 address = strndup(v, n);
3694 if (!address)
3695 return log_oom_debug();
3696
3697 if (v[n] != ' ')
3698 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EINVAL),
3699 "Failed to deserialize VarlinkServerSocket: %s: %m", value);
3700 v = startswith(v + n + 1, "varlink-server-socket-fd=");
3701 if (!v)
3702 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EINVAL),
3703 "Failed to deserialize VarlinkServerSocket fd %s: %m", value);
3704
3705 n = strcspn(v, " ");
3706 buf = strndupa_safe(v, n);
3707
3708 fd = parse_fd(buf);
3709 if (fd < 0)
3710 return varlink_server_log_errno(s, fd, "Unable to parse VarlinkServerSocket varlink-server-socket-fd=%s: %m", buf);
3711 if (!fdset_contains(fds, fd))
3712 return varlink_server_log_errno(s, SYNTHETIC_ERRNO(EBADF),
3713 "VarlinkServerSocket varlink-server-socket-fd= has unknown fd %d: %m", fd);
3714
3715 ss = new(VarlinkServerSocket, 1);
3716 if (!ss)
3717 return log_oom_debug();
3718
3719 *ss = (VarlinkServerSocket) {
3720 .server = s,
3721 .address = TAKE_PTR(address),
3722 .fd = fdset_remove(fds, fd),
3723 };
3724
3725 r = varlink_server_add_socket_event_source(s, ss, SD_EVENT_PRIORITY_NORMAL);
3726 if (r < 0)
3727 return varlink_server_log_errno(s, r, "Failed to add VarlinkServerSocket event source to the event loop: %m");
3728
3729 LIST_PREPEND(sockets, s->sockets, TAKE_PTR(ss));
3730 return 0;
3731 }
3732
3733 int varlink_invocation(VarlinkInvocationFlags flags) {
3734 _cleanup_strv_free_ char **names = NULL;
3735 int r, b;
3736 socklen_t l = sizeof(b);
3737
3738 /* Returns true if this is a "pure" varlink server invocation, i.e. with one fd passed. */
3739
3740 r = sd_listen_fds_with_names(/* unset_environment= */ false, &names);
3741 if (r < 0)
3742 return r;
3743 if (r == 0)
3744 return false;
3745 if (r > 1)
3746 return -ETOOMANYREFS;
3747
3748 if (!strv_equal(names, STRV_MAKE("varlink")))
3749 return false;
3750
3751 if (FLAGS_SET(flags, VARLINK_ALLOW_LISTEN|VARLINK_ALLOW_ACCEPT)) /* Both flags set? Then allow everything */
3752 return true;
3753
3754 if ((flags & (VARLINK_ALLOW_LISTEN|VARLINK_ALLOW_ACCEPT)) == 0) /* Neither is set, then fail */
3755 return -EISCONN;
3756
3757 if (getsockopt(SD_LISTEN_FDS_START, SOL_SOCKET, SO_ACCEPTCONN, &b, &l) < 0)
3758 return -errno;
3759
3760 assert(l == sizeof(b));
3761
3762 if (!FLAGS_SET(flags, b ? VARLINK_ALLOW_LISTEN : VARLINK_ALLOW_ACCEPT))
3763 return -EISCONN;
3764
3765 return true;
3766 }