chiark / gitweb /
Prep v234.4: ake all supportable API functions visible (v234 addition).
[elogind.git] / src / shared / bus-util.c
1 /***
2   This file is part of systemd.
3
4   Copyright 2013 Lennart Poettering
5
6   systemd is free software; you can redistribute it and/or modify it
7   under the terms of the GNU Lesser General Public License as published by
8   the Free Software Foundation; either version 2.1 of the License, or
9   (at your option) any later version.
10
11   systemd is distributed in the hope that it will be useful, but
12   WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14   Lesser General Public License for more details.
15
16   You should have received a copy of the GNU Lesser General Public License
17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <errno.h>
21 #include <fcntl.h>
22 #include <inttypes.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <sys/ioctl.h>
27 #include <sys/resource.h>
28 #include <sys/socket.h>
29 #include <unistd.h>
30
31 #include "sd-bus-protocol.h"
32 #include "sd-bus.h"
33 #include "sd-daemon.h"
34 #include "sd-event.h"
35 #include "sd-id128.h"
36
37 #include "alloc-util.h"
38 #include "bus-internal.h"
39 #include "bus-label.h"
40 #include "bus-message.h"
41 #include "bus-util.h"
42 #include "def.h"
43 #include "escape.h"
44 #include "fd-util.h"
45 #include "missing.h"
46 #include "nsflags.h"
47 #include "parse-util.h"
48 #include "proc-cmdline.h"
49 //#include "rlimit-util.h"
50 #include "stdio-util.h"
51 #include "strv.h"
52 #include "user-util.h"
53
54 #if 0 /// UNNEEDED by elogind
55 static int name_owner_change_callback(sd_bus_message *m, void *userdata, sd_bus_error *ret_error) {
56         sd_event *e = userdata;
57
58         assert(m);
59         assert(e);
60
61         sd_bus_close(sd_bus_message_get_bus(m));
62         sd_event_exit(e, 0);
63
64         return 1;
65 }
66
67 int bus_async_unregister_and_exit(sd_event *e, sd_bus *bus, const char *name) {
68         _cleanup_free_ char *match = NULL;
69         const char *unique;
70         int r;
71
72         assert(e);
73         assert(bus);
74         assert(name);
75
76         /* We unregister the name here and then wait for the
77          * NameOwnerChanged signal for this event to arrive before we
78          * quit. We do this in order to make sure that any queued
79          * requests are still processed before we really exit. */
80
81         r = sd_bus_get_unique_name(bus, &unique);
82         if (r < 0)
83                 return r;
84
85         r = asprintf(&match,
86                      "sender='org.freedesktop.DBus',"
87                      "type='signal',"
88                      "interface='org.freedesktop.DBus',"
89                      "member='NameOwnerChanged',"
90                      "path='/org/freedesktop/DBus',"
91                      "arg0='%s',"
92                      "arg1='%s',"
93                      "arg2=''", name, unique);
94         if (r < 0)
95                 return -ENOMEM;
96
97         r = sd_bus_add_match(bus, NULL, match, name_owner_change_callback, e);
98         if (r < 0)
99                 return r;
100
101         r = sd_bus_release_name(bus, name);
102         if (r < 0)
103                 return r;
104
105         return 0;
106 }
107
108 int bus_event_loop_with_idle(
109                 sd_event *e,
110                 sd_bus *bus,
111                 const char *name,
112                 usec_t timeout,
113                 check_idle_t check_idle,
114                 void *userdata) {
115         bool exiting = false;
116         int r, code;
117
118         assert(e);
119         assert(bus);
120         assert(name);
121
122         for (;;) {
123                 bool idle;
124
125                 r = sd_event_get_state(e);
126                 if (r < 0)
127                         return r;
128                 if (r == SD_EVENT_FINISHED)
129                         break;
130
131                 if (check_idle)
132                         idle = check_idle(userdata);
133                 else
134                         idle = true;
135
136                 r = sd_event_run(e, exiting || !idle ? (uint64_t) -1 : timeout);
137                 if (r < 0)
138                         return r;
139
140                 if (r == 0 && !exiting && idle) {
141
142                         r = sd_bus_try_close(bus);
143                         if (r == -EBUSY)
144                                 continue;
145
146                         /* Fallback for dbus1 connections: we
147                          * unregister the name and wait for the
148                          * response to come through for it */
149                         if (r == -EOPNOTSUPP) {
150
151                                 /* Inform the service manager that we
152                                  * are going down, so that it will
153                                  * queue all further start requests,
154                                  * instead of assuming we are already
155                                  * running. */
156                                 sd_notify(false, "STOPPING=1");
157
158                                 r = bus_async_unregister_and_exit(e, bus, name);
159                                 if (r < 0)
160                                         return r;
161
162                                 exiting = true;
163                                 continue;
164                         }
165
166                         if (r < 0)
167                                 return r;
168
169                         sd_event_exit(e, 0);
170                         break;
171                 }
172         }
173
174         r = sd_event_get_exit_code(e, &code);
175         if (r < 0)
176                 return r;
177
178         return code;
179 }
180 #endif // 0
181
182 int bus_name_has_owner(sd_bus *c, const char *name, sd_bus_error *error) {
183         _cleanup_(sd_bus_message_unrefp) sd_bus_message *rep = NULL;
184         int r, has_owner = 0;
185
186         assert(c);
187         assert(name);
188
189         r = sd_bus_call_method(c,
190                                "org.freedesktop.DBus",
191                                "/org/freedesktop/dbus",
192                                "org.freedesktop.DBus",
193                                "NameHasOwner",
194                                error,
195                                &rep,
196                                "s",
197                                name);
198         if (r < 0)
199                 return r;
200
201         r = sd_bus_message_read_basic(rep, 'b', &has_owner);
202         if (r < 0)
203                 return sd_bus_error_set_errno(error, r);
204
205         return has_owner;
206 }
207
208 static int check_good_user(sd_bus_message *m, uid_t good_user) {
209         _cleanup_(sd_bus_creds_unrefp) sd_bus_creds *creds = NULL;
210         uid_t sender_uid;
211         int r;
212
213         assert(m);
214
215         if (good_user == UID_INVALID)
216                 return 0;
217
218         r = sd_bus_query_sender_creds(m, SD_BUS_CREDS_EUID, &creds);
219         if (r < 0)
220                 return r;
221
222         /* Don't trust augmented credentials for authorization */
223         assert_return((sd_bus_creds_get_augmented_mask(creds) & SD_BUS_CREDS_EUID) == 0, -EPERM);
224
225         r = sd_bus_creds_get_euid(creds, &sender_uid);
226         if (r < 0)
227                 return r;
228
229         return sender_uid == good_user;
230 }
231
232 int bus_test_polkit(
233                 sd_bus_message *call,
234                 int capability,
235                 const char *action,
236                 const char **details,
237                 uid_t good_user,
238                 bool *_challenge,
239                 sd_bus_error *e) {
240
241         int r;
242
243         assert(call);
244         assert(action);
245
246         /* Tests non-interactively! */
247
248         r = check_good_user(call, good_user);
249         if (r != 0)
250                 return r;
251
252         r = sd_bus_query_sender_privilege(call, capability);
253         if (r < 0)
254                 return r;
255         else if (r > 0)
256                 return 1;
257 #ifdef ENABLE_POLKIT
258         else {
259                 _cleanup_(sd_bus_message_unrefp) sd_bus_message *request = NULL;
260                 _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
261                 int authorized = false, challenge = false;
262                 const char *sender, **k, **v;
263
264                 sender = sd_bus_message_get_sender(call);
265                 if (!sender)
266                         return -EBADMSG;
267
268                 r = sd_bus_message_new_method_call(
269                                 call->bus,
270                                 &request,
271                                 "org.freedesktop.PolicyKit1",
272                                 "/org/freedesktop/PolicyKit1/Authority",
273                                 "org.freedesktop.PolicyKit1.Authority",
274                                 "CheckAuthorization");
275                 if (r < 0)
276                         return r;
277
278                 r = sd_bus_message_append(
279                                 request,
280                                 "(sa{sv})s",
281                                 "system-bus-name", 1, "name", "s", sender,
282                                 action);
283                 if (r < 0)
284                         return r;
285
286                 r = sd_bus_message_open_container(request, 'a', "{ss}");
287                 if (r < 0)
288                         return r;
289
290                 STRV_FOREACH_PAIR(k, v, details) {
291                         r = sd_bus_message_append(request, "{ss}", *k, *v);
292                         if (r < 0)
293                                 return r;
294                 }
295
296                 r = sd_bus_message_close_container(request);
297                 if (r < 0)
298                         return r;
299
300                 r = sd_bus_message_append(request, "us", 0, NULL);
301                 if (r < 0)
302                         return r;
303
304                 r = sd_bus_call(call->bus, request, 0, e, &reply);
305                 if (r < 0) {
306                         /* Treat no PK available as access denied */
307                         if (sd_bus_error_has_name(e, SD_BUS_ERROR_SERVICE_UNKNOWN)) {
308                                 sd_bus_error_free(e);
309                                 return -EACCES;
310                         }
311
312                         return r;
313                 }
314
315                 r = sd_bus_message_enter_container(reply, 'r', "bba{ss}");
316                 if (r < 0)
317                         return r;
318
319                 r = sd_bus_message_read(reply, "bb", &authorized, &challenge);
320                 if (r < 0)
321                         return r;
322
323                 if (authorized)
324                         return 1;
325
326                 if (_challenge) {
327                         *_challenge = challenge;
328                         return 0;
329                 }
330         }
331 #endif
332
333         return -EACCES;
334 }
335
336 #ifdef ENABLE_POLKIT
337
338 typedef struct AsyncPolkitQuery {
339         sd_bus_message *request, *reply;
340         sd_bus_message_handler_t callback;
341         void *userdata;
342         sd_bus_slot *slot;
343         Hashmap *registry;
344 } AsyncPolkitQuery;
345
346 static void async_polkit_query_free(AsyncPolkitQuery *q) {
347
348         if (!q)
349                 return;
350
351         sd_bus_slot_unref(q->slot);
352
353         if (q->registry && q->request)
354                 hashmap_remove(q->registry, q->request);
355
356         sd_bus_message_unref(q->request);
357         sd_bus_message_unref(q->reply);
358
359         free(q);
360 }
361
362 static int async_polkit_callback(sd_bus_message *reply, void *userdata, sd_bus_error *error) {
363         _cleanup_(sd_bus_error_free) sd_bus_error error_buffer = SD_BUS_ERROR_NULL;
364         AsyncPolkitQuery *q = userdata;
365         int r;
366
367         assert(reply);
368         assert(q);
369
370         q->slot = sd_bus_slot_unref(q->slot);
371         q->reply = sd_bus_message_ref(reply);
372
373         r = sd_bus_message_rewind(q->request, true);
374         if (r < 0) {
375                 r = sd_bus_reply_method_errno(q->request, r, NULL);
376                 goto finish;
377         }
378
379         r = q->callback(q->request, q->userdata, &error_buffer);
380         r = bus_maybe_reply_error(q->request, r, &error_buffer);
381
382 finish:
383         async_polkit_query_free(q);
384
385         return r;
386 }
387
388 #endif
389
390 int bus_verify_polkit_async(
391                 sd_bus_message *call,
392                 int capability,
393                 const char *action,
394                 const char **details,
395                 bool interactive,
396                 uid_t good_user,
397                 Hashmap **registry,
398                 sd_bus_error *error) {
399
400 #ifdef ENABLE_POLKIT
401         _cleanup_(sd_bus_message_unrefp) sd_bus_message *pk = NULL;
402         AsyncPolkitQuery *q;
403         const char *sender, **k, **v;
404         sd_bus_message_handler_t callback;
405         void *userdata;
406         int c;
407 #endif
408         int r;
409
410         assert(call);
411         assert(action);
412         assert(registry);
413
414         r = check_good_user(call, good_user);
415         if (r != 0)
416                 return r;
417
418 #ifdef ENABLE_POLKIT
419         q = hashmap_get(*registry, call);
420         if (q) {
421                 int authorized, challenge;
422
423                 /* This is the second invocation of this function, and
424                  * there's already a response from polkit, let's
425                  * process it */
426                 assert(q->reply);
427
428                 if (sd_bus_message_is_method_error(q->reply, NULL)) {
429                         const sd_bus_error *e;
430
431                         /* Copy error from polkit reply */
432                         e = sd_bus_message_get_error(q->reply);
433                         sd_bus_error_copy(error, e);
434
435                         /* Treat no PK available as access denied */
436                         if (sd_bus_error_has_name(e, SD_BUS_ERROR_SERVICE_UNKNOWN))
437                                 return -EACCES;
438
439                         return -sd_bus_error_get_errno(e);
440                 }
441
442                 r = sd_bus_message_enter_container(q->reply, 'r', "bba{ss}");
443                 if (r >= 0)
444                         r = sd_bus_message_read(q->reply, "bb", &authorized, &challenge);
445
446                 if (r < 0)
447                         return r;
448
449                 if (authorized)
450                         return 1;
451
452                 if (challenge)
453                         return sd_bus_error_set(error, SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED, "Interactive authentication required.");
454
455                 return -EACCES;
456         }
457 #endif
458
459         r = sd_bus_query_sender_privilege(call, capability);
460         if (r < 0)
461                 return r;
462         else if (r > 0)
463                 return 1;
464
465 #ifdef ENABLE_POLKIT
466         if (sd_bus_get_current_message(call->bus) != call)
467                 return -EINVAL;
468
469         callback = sd_bus_get_current_handler(call->bus);
470         if (!callback)
471                 return -EINVAL;
472
473         userdata = sd_bus_get_current_userdata(call->bus);
474
475         sender = sd_bus_message_get_sender(call);
476         if (!sender)
477                 return -EBADMSG;
478
479         c = sd_bus_message_get_allow_interactive_authorization(call);
480         if (c < 0)
481                 return c;
482         if (c > 0)
483                 interactive = true;
484
485         r = hashmap_ensure_allocated(registry, NULL);
486         if (r < 0)
487                 return r;
488
489         r = sd_bus_message_new_method_call(
490                         call->bus,
491                         &pk,
492                         "org.freedesktop.PolicyKit1",
493                         "/org/freedesktop/PolicyKit1/Authority",
494                         "org.freedesktop.PolicyKit1.Authority",
495                         "CheckAuthorization");
496         if (r < 0)
497                 return r;
498
499         r = sd_bus_message_append(
500                         pk,
501                         "(sa{sv})s",
502                         "system-bus-name", 1, "name", "s", sender,
503                         action);
504         if (r < 0)
505                 return r;
506
507         r = sd_bus_message_open_container(pk, 'a', "{ss}");
508         if (r < 0)
509                 return r;
510
511         STRV_FOREACH_PAIR(k, v, details) {
512                 r = sd_bus_message_append(pk, "{ss}", *k, *v);
513                 if (r < 0)
514                         return r;
515         }
516
517         r = sd_bus_message_close_container(pk);
518         if (r < 0)
519                 return r;
520
521         r = sd_bus_message_append(pk, "us", !!interactive, NULL);
522         if (r < 0)
523                 return r;
524
525         q = new0(AsyncPolkitQuery, 1);
526         if (!q)
527                 return -ENOMEM;
528
529         q->request = sd_bus_message_ref(call);
530         q->callback = callback;
531         q->userdata = userdata;
532
533         r = hashmap_put(*registry, call, q);
534         if (r < 0) {
535                 async_polkit_query_free(q);
536                 return r;
537         }
538
539         q->registry = *registry;
540
541         r = sd_bus_call_async(call->bus, &q->slot, pk, async_polkit_callback, q, 0);
542         if (r < 0) {
543                 async_polkit_query_free(q);
544                 return r;
545         }
546
547         return 0;
548 #endif
549
550         return -EACCES;
551 }
552
553 void bus_verify_polkit_async_registry_free(Hashmap *registry) {
554 #ifdef ENABLE_POLKIT
555         AsyncPolkitQuery *q;
556
557         while ((q = hashmap_steal_first(registry)))
558                 async_polkit_query_free(q);
559
560         hashmap_free(registry);
561 #endif
562 }
563
564 #if 0 /// UNNEEDED by elogind
565 int bus_check_peercred(sd_bus *c) {
566         struct ucred ucred;
567         socklen_t l;
568         int fd;
569
570         assert(c);
571
572         fd = sd_bus_get_fd(c);
573         if (fd < 0)
574                 return fd;
575
576         l = sizeof(struct ucred);
577         if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &l) < 0)
578                 return -errno;
579
580         if (l != sizeof(struct ucred))
581                 return -E2BIG;
582
583         if (ucred.uid != 0 && ucred.uid != geteuid())
584                 return -EPERM;
585
586         return 1;
587 }
588
589 int bus_connect_system_systemd(sd_bus **_bus) {
590         _cleanup_(sd_bus_unrefp) sd_bus *bus = NULL;
591         int r;
592
593         assert(_bus);
594
595         if (geteuid() != 0)
596                 return sd_bus_default_system(_bus);
597
598         /* If we are root and kdbus is not available, then let's talk
599          * directly to the system instance, instead of going via the
600          * bus */
601
602         r = sd_bus_new(&bus);
603         if (r < 0)
604                 return r;
605
606         r = sd_bus_set_address(bus, KERNEL_SYSTEM_BUS_ADDRESS);
607         if (r < 0)
608                 return r;
609
610         bus->bus_client = true;
611
612         r = sd_bus_start(bus);
613         if (r >= 0) {
614                 *_bus = bus;
615                 bus = NULL;
616                 return 0;
617         }
618
619         bus = sd_bus_unref(bus);
620
621         r = sd_bus_new(&bus);
622         if (r < 0)
623                 return r;
624
625         r = sd_bus_set_address(bus, "unix:path=/run/systemd/private");
626         if (r < 0)
627                 return r;
628
629         r = sd_bus_start(bus);
630         if (r < 0)
631                 return sd_bus_default_system(_bus);
632
633         r = bus_check_peercred(bus);
634         if (r < 0)
635                 return r;
636
637         *_bus = bus;
638         bus = NULL;
639
640         return 0;
641 }
642
643 int bus_connect_user_systemd(sd_bus **_bus) {
644         _cleanup_(sd_bus_unrefp) sd_bus *bus = NULL;
645         _cleanup_free_ char *ee = NULL;
646         const char *e;
647         int r;
648
649         /* Try via kdbus first, and then directly */
650
651         assert(_bus);
652
653         r = sd_bus_new(&bus);
654         if (r < 0)
655                 return r;
656
657         if (asprintf(&bus->address, KERNEL_USER_BUS_ADDRESS_FMT, getuid()) < 0)
658                 return -ENOMEM;
659
660         bus->bus_client = true;
661
662         r = sd_bus_start(bus);
663         if (r >= 0) {
664                 *_bus = bus;
665                 bus = NULL;
666                 return 0;
667         }
668
669         bus = sd_bus_unref(bus);
670
671         e = secure_getenv("XDG_RUNTIME_DIR");
672         if (!e)
673                 return sd_bus_default_user(_bus);
674
675         ee = bus_address_escape(e);
676         if (!ee)
677                 return -ENOMEM;
678
679         r = sd_bus_new(&bus);
680         if (r < 0)
681                 return r;
682
683         bus->address = strjoin("unix:path=", ee, "/systemd/private");
684         if (!bus->address)
685                 return -ENOMEM;
686
687         r = sd_bus_start(bus);
688         if (r < 0)
689                 return sd_bus_default_user(_bus);
690
691         r = bus_check_peercred(bus);
692         if (r < 0)
693                 return r;
694
695         *_bus = bus;
696         bus = NULL;
697
698         return 0;
699 }
700 #endif // 0
701
702 #define print_property(name, fmt, ...)                                  \
703         do {                                                            \
704                 if (value)                                              \
705                         printf(fmt "\n", __VA_ARGS__);                  \
706                 else                                                    \
707                         printf("%s=" fmt "\n", name, __VA_ARGS__);      \
708         } while(0)
709
710 int bus_print_property(const char *name, sd_bus_message *property, bool value, bool all) {
711         char type;
712         const char *contents;
713         int r;
714
715         assert(name);
716         assert(property);
717
718         r = sd_bus_message_peek_type(property, &type, &contents);
719         if (r < 0)
720                 return r;
721
722         switch (type) {
723
724         case SD_BUS_TYPE_STRING: {
725                 const char *s;
726
727                 r = sd_bus_message_read_basic(property, type, &s);
728                 if (r < 0)
729                         return r;
730
731                 if (all || !isempty(s)) {
732                         bool good;
733
734                         /* This property has a single value, so we need to take
735                          * care not to print a new line, everything else is OK. */
736                         good = !strchr(s, '\n');
737                         print_property(name, "%s", good ? s : "[unprintable]");
738                 }
739
740                 return 1;
741         }
742
743         case SD_BUS_TYPE_BOOLEAN: {
744                 int b;
745
746                 r = sd_bus_message_read_basic(property, type, &b);
747                 if (r < 0)
748                         return r;
749
750                 print_property(name, "%s", yes_no(b));
751
752                 return 1;
753         }
754
755         case SD_BUS_TYPE_UINT64: {
756                 uint64_t u;
757
758                 r = sd_bus_message_read_basic(property, type, &u);
759                 if (r < 0)
760                         return r;
761
762                 /* Yes, heuristics! But we can change this check
763                  * should it turn out to not be sufficient */
764
765                 if (endswith(name, "Timestamp")) {
766                         char timestamp[FORMAT_TIMESTAMP_MAX], *t;
767
768                         t = format_timestamp(timestamp, sizeof(timestamp), u);
769                         if (t || all)
770                                 print_property(name, "%s", strempty(t));
771
772                 } else if (strstr(name, "USec")) {
773                         char timespan[FORMAT_TIMESPAN_MAX];
774
775                         print_property(name, "%s", format_timespan(timespan, sizeof(timespan), u, 0));
776                 } else if (streq(name, "RestrictNamespaces")) {
777                         _cleanup_free_ char *s = NULL;
778                         const char *result = NULL;
779
780                         if ((u & NAMESPACE_FLAGS_ALL) == 0)
781                                 result = "yes";
782                         else if ((u & NAMESPACE_FLAGS_ALL) == NAMESPACE_FLAGS_ALL)
783                                 result = "no";
784                         else {
785                                 r = namespace_flag_to_string_many(u, &s);
786                                 if (r < 0)
787                                         return r;
788
789                                 result = s;
790                         }
791
792                         print_property(name, "%s", result);
793                 } else
794                         print_property(name, "%"PRIu64, u);
795
796                 return 1;
797         }
798
799         case SD_BUS_TYPE_INT64: {
800                 int64_t i;
801
802                 r = sd_bus_message_read_basic(property, type, &i);
803                 if (r < 0)
804                         return r;
805
806                 print_property(name, "%"PRIi64, i);
807
808                 return 1;
809         }
810
811         case SD_BUS_TYPE_UINT32: {
812                 uint32_t u;
813
814                 r = sd_bus_message_read_basic(property, type, &u);
815                 if (r < 0)
816                         return r;
817
818                 if (strstr(name, "UMask") || strstr(name, "Mode"))
819                         print_property(name, "%04o", u);
820                 else
821                         print_property(name, "%"PRIu32, u);
822
823                 return 1;
824         }
825
826         case SD_BUS_TYPE_INT32: {
827                 int32_t i;
828
829                 r = sd_bus_message_read_basic(property, type, &i);
830                 if (r < 0)
831                         return r;
832
833                 print_property(name, "%"PRIi32, i);
834                 return 1;
835         }
836
837         case SD_BUS_TYPE_DOUBLE: {
838                 double d;
839
840                 r = sd_bus_message_read_basic(property, type, &d);
841                 if (r < 0)
842                         return r;
843
844                 print_property(name, "%g", d);
845                 return 1;
846         }
847
848         case SD_BUS_TYPE_ARRAY:
849                 if (streq(contents, "s")) {
850                         bool first = true;
851                         const char *str;
852
853                         r = sd_bus_message_enter_container(property, SD_BUS_TYPE_ARRAY, contents);
854                         if (r < 0)
855                                 return r;
856
857                         while ((r = sd_bus_message_read_basic(property, SD_BUS_TYPE_STRING, &str)) > 0) {
858                                 bool good;
859
860                                 if (first && !value)
861                                         printf("%s=", name);
862
863                                 /* This property has multiple space-seperated values, so
864                                  * neither spaces not newlines can be allowed in a value. */
865                                 good = str[strcspn(str, " \n")] == '\0';
866
867                                 printf("%s%s", first ? "" : " ", good ? str : "[unprintable]");
868
869                                 first = false;
870                         }
871                         if (r < 0)
872                                 return r;
873
874                         if (first && all && !value)
875                                 printf("%s=", name);
876                         if (!first || all)
877                                 puts("");
878
879                         r = sd_bus_message_exit_container(property);
880                         if (r < 0)
881                                 return r;
882
883                         return 1;
884
885                 } else if (streq(contents, "y")) {
886                         const uint8_t *u;
887                         size_t n;
888
889                         r = sd_bus_message_read_array(property, SD_BUS_TYPE_BYTE, (const void**) &u, &n);
890                         if (r < 0)
891                                 return r;
892
893                         if (all || n > 0) {
894                                 unsigned int i;
895
896                                 if (!value)
897                                         printf("%s=", name);
898
899                                 for (i = 0; i < n; i++)
900                                         printf("%02x", u[i]);
901
902                                 puts("");
903                         }
904
905                         return 1;
906
907                 } else if (streq(contents, "u")) {
908                         uint32_t *u;
909                         size_t n;
910
911                         r = sd_bus_message_read_array(property, SD_BUS_TYPE_UINT32, (const void**) &u, &n);
912                         if (r < 0)
913                                 return r;
914
915                         if (all || n > 0) {
916                                 unsigned int i;
917
918                                 if (!value)
919                                         printf("%s=", name);
920
921                                 for (i = 0; i < n; i++)
922                                         printf("%08x", u[i]);
923
924                                 puts("");
925                         }
926
927                         return 1;
928                 }
929
930                 break;
931         }
932
933         return 0;
934 }
935
936 int bus_print_all_properties(sd_bus *bus, const char *dest, const char *path, char **filter, bool value, bool all) {
937         _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
938         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
939         int r;
940
941         assert(bus);
942         assert(path);
943
944         r = sd_bus_call_method(bus,
945                         dest,
946                         path,
947                         "org.freedesktop.DBus.Properties",
948                         "GetAll",
949                         &error,
950                         &reply,
951                         "s", "");
952         if (r < 0)
953                 return r;
954
955         r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_ARRAY, "{sv}");
956         if (r < 0)
957                 return r;
958
959         while ((r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_DICT_ENTRY, "sv")) > 0) {
960                 const char *name;
961                 const char *contents;
962
963                 r = sd_bus_message_read_basic(reply, SD_BUS_TYPE_STRING, &name);
964                 if (r < 0)
965                         return r;
966
967                 if (!filter || strv_find(filter, name)) {
968                         r = sd_bus_message_peek_type(reply, NULL, &contents);
969                         if (r < 0)
970                                 return r;
971
972                         r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_VARIANT, contents);
973                         if (r < 0)
974                                 return r;
975
976                         r = bus_print_property(name, reply, value, all);
977                         if (r < 0)
978                                 return r;
979                         if (r == 0) {
980                                 if (all)
981                                         printf("%s=[unprintable]\n", name);
982                                 /* skip what we didn't read */
983                                 r = sd_bus_message_skip(reply, contents);
984                                 if (r < 0)
985                                         return r;
986                         }
987
988                         r = sd_bus_message_exit_container(reply);
989                         if (r < 0)
990                                 return r;
991                 } else {
992                         r = sd_bus_message_skip(reply, "v");
993                         if (r < 0)
994                                 return r;
995                 }
996
997                 r = sd_bus_message_exit_container(reply);
998                 if (r < 0)
999                         return r;
1000         }
1001         if (r < 0)
1002                 return r;
1003
1004         r = sd_bus_message_exit_container(reply);
1005         if (r < 0)
1006                 return r;
1007
1008         return 0;
1009 }
1010
1011 int bus_map_id128(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata) {
1012         sd_id128_t *p = userdata;
1013         const void *v;
1014         size_t n;
1015         int r;
1016
1017         r = sd_bus_message_read_array(m, SD_BUS_TYPE_BYTE, &v, &n);
1018         if (r < 0)
1019                 return r;
1020
1021         if (n == 0)
1022                 *p = SD_ID128_NULL;
1023         else if (n == 16)
1024                 memcpy((*p).bytes, v, n);
1025         else
1026                 return -EINVAL;
1027
1028         return 0;
1029 }
1030
1031 static int map_basic(sd_bus *bus, const char *member, sd_bus_message *m, sd_bus_error *error, void *userdata) {
1032         char type;
1033         int r;
1034
1035         r = sd_bus_message_peek_type(m, &type, NULL);
1036         if (r < 0)
1037                 return r;
1038
1039         switch (type) {
1040
1041         case SD_BUS_TYPE_STRING: {
1042                 char **p = userdata;
1043                 const char *s;
1044
1045                 r = sd_bus_message_read_basic(m, type, &s);
1046                 if (r < 0)
1047                         return r;
1048
1049                 if (isempty(s))
1050                         s = NULL;
1051
1052                 return free_and_strdup(p, s);
1053         }
1054
1055         case SD_BUS_TYPE_ARRAY: {
1056                 _cleanup_strv_free_ char **l = NULL;
1057                 char ***p = userdata;
1058
1059                 r = bus_message_read_strv_extend(m, &l);
1060                 if (r < 0)
1061                         return r;
1062
1063                 strv_free(*p);
1064                 *p = l;
1065                 l = NULL;
1066                 return 0;
1067         }
1068
1069         case SD_BUS_TYPE_BOOLEAN: {
1070                 unsigned b;
1071                 int *p = userdata;
1072
1073                 r = sd_bus_message_read_basic(m, type, &b);
1074                 if (r < 0)
1075                         return r;
1076
1077                 *p = b;
1078                 return 0;
1079         }
1080
1081         case SD_BUS_TYPE_INT32:
1082         case SD_BUS_TYPE_UINT32: {
1083                 uint32_t u, *p = userdata;
1084
1085                 r = sd_bus_message_read_basic(m, type, &u);
1086                 if (r < 0)
1087                         return r;
1088
1089                 *p = u;
1090                 return 0;
1091         }
1092
1093         case SD_BUS_TYPE_INT64:
1094         case SD_BUS_TYPE_UINT64: {
1095                 uint64_t t, *p = userdata;
1096
1097                 r = sd_bus_message_read_basic(m, type, &t);
1098                 if (r < 0)
1099                         return r;
1100
1101                 *p = t;
1102                 return 0;
1103         }
1104
1105         case SD_BUS_TYPE_DOUBLE: {
1106                 double d, *p = userdata;
1107
1108                 r = sd_bus_message_read_basic(m, type, &d);
1109                 if (r < 0)
1110                         return r;
1111
1112                 *p = d;
1113                 return 0;
1114         }}
1115
1116         return -EOPNOTSUPP;
1117 }
1118
1119 int bus_message_map_all_properties(
1120                 sd_bus_message *m,
1121                 const struct bus_properties_map *map,
1122                 sd_bus_error *error,
1123                 void *userdata) {
1124
1125         int r;
1126
1127         assert(m);
1128         assert(map);
1129
1130         r = sd_bus_message_enter_container(m, SD_BUS_TYPE_ARRAY, "{sv}");
1131         if (r < 0)
1132                 return r;
1133
1134         while ((r = sd_bus_message_enter_container(m, SD_BUS_TYPE_DICT_ENTRY, "sv")) > 0) {
1135                 const struct bus_properties_map *prop;
1136                 const char *member;
1137                 const char *contents;
1138                 void *v;
1139                 unsigned i;
1140
1141                 r = sd_bus_message_read_basic(m, SD_BUS_TYPE_STRING, &member);
1142                 if (r < 0)
1143                         return r;
1144
1145                 for (i = 0, prop = NULL; map[i].member; i++)
1146                         if (streq(map[i].member, member)) {
1147                                 prop = &map[i];
1148                                 break;
1149                         }
1150
1151                 if (prop) {
1152                         r = sd_bus_message_peek_type(m, NULL, &contents);
1153                         if (r < 0)
1154                                 return r;
1155
1156                         r = sd_bus_message_enter_container(m, SD_BUS_TYPE_VARIANT, contents);
1157                         if (r < 0)
1158                                 return r;
1159
1160                         v = (uint8_t *)userdata + prop->offset;
1161                         if (map[i].set)
1162                                 r = prop->set(sd_bus_message_get_bus(m), member, m, error, v);
1163                         else
1164                                 r = map_basic(sd_bus_message_get_bus(m), member, m, error, v);
1165                         if (r < 0)
1166                                 return r;
1167
1168                         r = sd_bus_message_exit_container(m);
1169                         if (r < 0)
1170                                 return r;
1171                 } else {
1172                         r = sd_bus_message_skip(m, "v");
1173                         if (r < 0)
1174                                 return r;
1175                 }
1176
1177                 r = sd_bus_message_exit_container(m);
1178                 if (r < 0)
1179                         return r;
1180         }
1181         if (r < 0)
1182                 return r;
1183
1184         return sd_bus_message_exit_container(m);
1185 }
1186
1187 #if 0 /// UNNEEDED by elogind
1188 int bus_message_map_properties_changed(
1189                 sd_bus_message *m,
1190                 const struct bus_properties_map *map,
1191                 sd_bus_error *error,
1192                 void *userdata) {
1193
1194         const char *member;
1195         int r, invalidated, i;
1196
1197         assert(m);
1198         assert(map);
1199
1200         r = bus_message_map_all_properties(m, map, error, userdata);
1201         if (r < 0)
1202                 return r;
1203
1204         r = sd_bus_message_enter_container(m, SD_BUS_TYPE_ARRAY, "s");
1205         if (r < 0)
1206                 return r;
1207
1208         invalidated = 0;
1209         while ((r = sd_bus_message_read_basic(m, SD_BUS_TYPE_STRING, &member)) > 0)
1210                 for (i = 0; map[i].member; i++)
1211                         if (streq(map[i].member, member)) {
1212                                 ++invalidated;
1213                                 break;
1214                         }
1215         if (r < 0)
1216                 return r;
1217
1218         r = sd_bus_message_exit_container(m);
1219         if (r < 0)
1220                 return r;
1221
1222         return invalidated;
1223 }
1224 #endif // 0
1225
1226 int bus_map_all_properties(
1227                 sd_bus *bus,
1228                 const char *destination,
1229                 const char *path,
1230                 const struct bus_properties_map *map,
1231                 sd_bus_error *error,
1232                 void *userdata) {
1233
1234         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
1235         int r;
1236
1237         assert(bus);
1238         assert(destination);
1239         assert(path);
1240         assert(map);
1241
1242         r = sd_bus_call_method(
1243                         bus,
1244                         destination,
1245                         path,
1246                         "org.freedesktop.DBus.Properties",
1247                         "GetAll",
1248                         error,
1249                         &m,
1250                         "s", "");
1251         if (r < 0)
1252                 return r;
1253
1254         return bus_message_map_all_properties(m, map, error, userdata);
1255 }
1256
1257 int bus_connect_transport(BusTransport transport, const char *host, bool user, sd_bus **ret) {
1258         _cleanup_(sd_bus_unrefp) sd_bus *bus = NULL;
1259         int r;
1260
1261         assert(transport >= 0);
1262         assert(transport < _BUS_TRANSPORT_MAX);
1263         assert(ret);
1264
1265         assert_return((transport == BUS_TRANSPORT_LOCAL) == !host, -EINVAL);
1266         assert_return(transport == BUS_TRANSPORT_LOCAL || !user, -EOPNOTSUPP);
1267
1268         switch (transport) {
1269
1270         case BUS_TRANSPORT_LOCAL:
1271 #if 0 /// elogind does not support a user bus
1272                 if (user)
1273                         r = sd_bus_default_user(&bus);
1274                 else
1275 #endif // 0
1276                         r = sd_bus_default_system(&bus);
1277
1278                 break;
1279
1280         case BUS_TRANSPORT_REMOTE:
1281                 r = sd_bus_open_system_remote(&bus, host);
1282                 break;
1283
1284         case BUS_TRANSPORT_MACHINE:
1285                 r = sd_bus_open_system_machine(&bus, host);
1286                 break;
1287
1288         default:
1289                 assert_not_reached("Hmm, unknown transport type.");
1290         }
1291         if (r < 0)
1292                 return r;
1293
1294         r = sd_bus_set_exit_on_disconnect(bus, true);
1295         if (r < 0)
1296                 return r;
1297
1298         *ret = bus;
1299         bus = NULL;
1300
1301         return 0;
1302 }
1303
1304 #if 0 /// UNNEEDED by elogind
1305 int bus_connect_transport_systemd(BusTransport transport, const char *host, bool user, sd_bus **bus) {
1306         int r;
1307
1308         assert(transport >= 0);
1309         assert(transport < _BUS_TRANSPORT_MAX);
1310         assert(bus);
1311
1312         assert_return((transport == BUS_TRANSPORT_LOCAL) == !host, -EINVAL);
1313         assert_return(transport == BUS_TRANSPORT_LOCAL || !user, -EOPNOTSUPP);
1314
1315         switch (transport) {
1316
1317         case BUS_TRANSPORT_LOCAL:
1318                 if (user)
1319                         r = bus_connect_user_systemd(bus);
1320                 else
1321                         r = bus_connect_system_systemd(bus);
1322
1323                 break;
1324
1325         case BUS_TRANSPORT_REMOTE:
1326                 r = sd_bus_open_system_remote(bus, host);
1327                 break;
1328
1329         case BUS_TRANSPORT_MACHINE:
1330                 r = sd_bus_open_system_machine(bus, host);
1331                 break;
1332
1333         default:
1334                 assert_not_reached("Hmm, unknown transport type.");
1335         }
1336
1337         return r;
1338 }
1339 #endif // 0
1340
1341 int bus_property_get_bool(
1342                 sd_bus *bus,
1343                 const char *path,
1344                 const char *interface,
1345                 const char *property,
1346                 sd_bus_message *reply,
1347                 void *userdata,
1348                 sd_bus_error *error) {
1349
1350         int b = *(bool*) userdata;
1351
1352         return sd_bus_message_append_basic(reply, 'b', &b);
1353 }
1354
1355 #if 0 /// UNNEEDED by elogind
1356 int bus_property_get_id128(
1357                 sd_bus *bus,
1358                 const char *path,
1359                 const char *interface,
1360                 const char *property,
1361                 sd_bus_message *reply,
1362                 void *userdata,
1363                 sd_bus_error *error) {
1364
1365         sd_id128_t *id = userdata;
1366
1367         if (sd_id128_is_null(*id)) /* Add an empty array if the ID is zero */
1368                 return sd_bus_message_append(reply, "ay", 0);
1369         else
1370                 return sd_bus_message_append_array(reply, 'y', id->bytes, 16);
1371 }
1372 #endif // 0
1373
1374 #if __SIZEOF_SIZE_T__ != 8
1375 int bus_property_get_size(
1376                 sd_bus *bus,
1377                 const char *path,
1378                 const char *interface,
1379                 const char *property,
1380                 sd_bus_message *reply,
1381                 void *userdata,
1382                 sd_bus_error *error) {
1383
1384         uint64_t sz = *(size_t*) userdata;
1385
1386         return sd_bus_message_append_basic(reply, 't', &sz);
1387 }
1388 #endif
1389
1390 #if __SIZEOF_LONG__ != 8
1391 int bus_property_get_long(
1392                 sd_bus *bus,
1393                 const char *path,
1394                 const char *interface,
1395                 const char *property,
1396                 sd_bus_message *reply,
1397                 void *userdata,
1398                 sd_bus_error *error) {
1399
1400         int64_t l = *(long*) userdata;
1401
1402         return sd_bus_message_append_basic(reply, 'x', &l);
1403 }
1404
1405 int bus_property_get_ulong(
1406                 sd_bus *bus,
1407                 const char *path,
1408                 const char *interface,
1409                 const char *property,
1410                 sd_bus_message *reply,
1411                 void *userdata,
1412                 sd_bus_error *error) {
1413
1414         uint64_t ul = *(unsigned long*) userdata;
1415
1416         return sd_bus_message_append_basic(reply, 't', &ul);
1417 }
1418 #endif
1419
1420 int bus_log_parse_error(int r) {
1421         return log_error_errno(r, "Failed to parse bus message: %m");
1422 }
1423
1424 #if 0 /// UNNEEDED by elogind
1425 int bus_log_create_error(int r) {
1426         return log_error_errno(r, "Failed to create bus message: %m");
1427 }
1428
1429 #endif // 0
1430 #if 0 /// UNNEEDED by elogind
1431 /**
1432  * bus_path_encode_unique() - encode unique object path
1433  * @b: bus connection or NULL
1434  * @prefix: object path prefix
1435  * @sender_id: unique-name of client, or NULL
1436  * @external_id: external ID to be chosen by client, or NULL
1437  * @ret_path: storage for encoded object path pointer
1438  *
1439  * Whenever we provide a bus API that allows clients to create and manage
1440  * server-side objects, we need to provide a unique name for these objects. If
1441  * we let the server choose the name, we suffer from a race condition: If a
1442  * client creates an object asynchronously, it cannot destroy that object until
1443  * it received the method reply. It cannot know the name of the new object,
1444  * thus, it cannot destroy it. Furthermore, it enforces a round-trip.
1445  *
1446  * Therefore, many APIs allow the client to choose the unique name for newly
1447  * created objects. There're two problems to solve, though:
1448  *    1) Object names are usually defined via dbus object paths, which are
1449  *       usually globally namespaced. Therefore, multiple clients must be able
1450  *       to choose unique object names without interference.
1451  *    2) If multiple libraries share the same bus connection, they must be
1452  *       able to choose unique object names without interference.
1453  * The first problem is solved easily by prefixing a name with the
1454  * unique-bus-name of a connection. The server side must enforce this and
1455  * reject any other name. The second problem is solved by providing unique
1456  * suffixes from within sd-bus.
1457  *
1458  * This helper allows clients to create unique object-paths. It uses the
1459  * template '/prefix/sender_id/external_id' and returns the new path in
1460  * @ret_path (must be freed by the caller).
1461  * If @sender_id is NULL, the unique-name of @b is used. If @external_id is
1462  * NULL, this function allocates a unique suffix via @b (by requesting a new
1463  * cookie). If both @sender_id and @external_id are given, @b can be passed as
1464  * NULL.
1465  *
1466  * Returns: 0 on success, negative error code on failure.
1467  */
1468 int bus_path_encode_unique(sd_bus *b, const char *prefix, const char *sender_id, const char *external_id, char **ret_path) {
1469         _cleanup_free_ char *sender_label = NULL, *external_label = NULL;
1470         char external_buf[DECIMAL_STR_MAX(uint64_t)], *p;
1471         int r;
1472
1473         assert_return(b || (sender_id && external_id), -EINVAL);
1474         assert_return(object_path_is_valid(prefix), -EINVAL);
1475         assert_return(ret_path, -EINVAL);
1476
1477         if (!sender_id) {
1478                 r = sd_bus_get_unique_name(b, &sender_id);
1479                 if (r < 0)
1480                         return r;
1481         }
1482
1483         if (!external_id) {
1484                 xsprintf(external_buf, "%"PRIu64, ++b->cookie);
1485                 external_id = external_buf;
1486         }
1487
1488         sender_label = bus_label_escape(sender_id);
1489         if (!sender_label)
1490                 return -ENOMEM;
1491
1492         external_label = bus_label_escape(external_id);
1493         if (!external_label)
1494                 return -ENOMEM;
1495
1496         p = strjoin(prefix, "/", sender_label, "/", external_label);
1497         if (!p)
1498                 return -ENOMEM;
1499
1500         *ret_path = p;
1501         return 0;
1502 }
1503
1504 /**
1505  * bus_path_decode_unique() - decode unique object path
1506  * @path: object path to decode
1507  * @prefix: object path prefix
1508  * @ret_sender: output parameter for sender-id label
1509  * @ret_external: output parameter for external-id label
1510  *
1511  * This does the reverse of bus_path_encode_unique() (see its description for
1512  * details). Both trailing labels, sender-id and external-id, are unescaped and
1513  * returned in the given output parameters (the caller must free them).
1514  *
1515  * Note that this function returns 0 if the path does not match the template
1516  * (see bus_path_encode_unique()), 1 if it matched.
1517  *
1518  * Returns: Negative error code on failure, 0 if the given object path does not
1519  *          match the template (return parameters are set to NULL), 1 if it was
1520  *          parsed successfully (return parameters contain allocated labels).
1521  */
1522 int bus_path_decode_unique(const char *path, const char *prefix, char **ret_sender, char **ret_external) {
1523         const char *p, *q;
1524         char *sender, *external;
1525
1526         assert(object_path_is_valid(path));
1527         assert(object_path_is_valid(prefix));
1528         assert(ret_sender);
1529         assert(ret_external);
1530
1531         p = object_path_startswith(path, prefix);
1532         if (!p) {
1533                 *ret_sender = NULL;
1534                 *ret_external = NULL;
1535                 return 0;
1536         }
1537
1538         q = strchr(p, '/');
1539         if (!q) {
1540                 *ret_sender = NULL;
1541                 *ret_external = NULL;
1542                 return 0;
1543         }
1544
1545         sender = bus_label_unescape_n(p, q - p);
1546         external = bus_label_unescape(q + 1);
1547         if (!sender || !external) {
1548                 free(sender);
1549                 free(external);
1550                 return -ENOMEM;
1551         }
1552
1553         *ret_sender = sender;
1554         *ret_external = external;
1555         return 1;
1556 }
1557 #endif // 0
1558
1559 #if 0 /// UNNEEDED by elogind
1560 int bus_property_get_rlimit(
1561                 sd_bus *bus,
1562                 const char *path,
1563                 const char *interface,
1564                 const char *property,
1565                 sd_bus_message *reply,
1566                 void *userdata,
1567                 sd_bus_error *error) {
1568
1569         struct rlimit *rl;
1570         uint64_t u;
1571         rlim_t x;
1572         const char *is_soft;
1573
1574         assert(bus);
1575         assert(reply);
1576         assert(userdata);
1577
1578         is_soft = endswith(property, "Soft");
1579         rl = *(struct rlimit**) userdata;
1580         if (rl)
1581                 x = is_soft ? rl->rlim_cur : rl->rlim_max;
1582         else {
1583                 struct rlimit buf = {};
1584                 int z;
1585                 const char *s;
1586
1587                 s = is_soft ? strndupa(property, is_soft - property) : property;
1588
1589                 z = rlimit_from_string(strstr(s, "Limit"));
1590                 assert(z >= 0);
1591
1592                 getrlimit(z, &buf);
1593                 x = is_soft ? buf.rlim_cur : buf.rlim_max;
1594         }
1595
1596         /* rlim_t might have different sizes, let's map
1597          * RLIMIT_INFINITY to (uint64_t) -1, so that it is the same on
1598          * all archs */
1599         u = x == RLIM_INFINITY ? (uint64_t) -1 : (uint64_t) x;
1600
1601         return sd_bus_message_append(reply, "t", u);
1602 }
1603
1604 int bus_track_add_name_many(sd_bus_track *t, char **l) {
1605         int r = 0;
1606         char **i;
1607
1608         assert(t);
1609
1610         /* Continues adding after failure, and returns the first failure. */
1611
1612         STRV_FOREACH(i, l) {
1613                 int k;
1614
1615                 k = sd_bus_track_add_name(t, *i);
1616                 if (k < 0 && r >= 0)
1617                         r = k;
1618         }
1619
1620         return r;
1621 }
1622 #endif // 0