1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 This file is part of systemd.
5 Copyright 2013 Lennart Poettering
14 #include <sys/ioctl.h>
15 #include <sys/resource.h>
16 #include <sys/socket.h>
19 #include "sd-bus-protocol.h"
21 #include "sd-daemon.h"
25 #include "alloc-util.h"
26 #include "bus-internal.h"
27 #include "bus-label.h"
28 #include "bus-message.h"
31 #include "cgroup-util.h"
36 #include "mount-util.h"
38 #include "parse-util.h"
39 #include "proc-cmdline.h"
40 #include "rlimit-util.h"
41 #include "stdio-util.h"
43 #include "user-util.h"
45 static int name_owner_change_callback(sd_bus_message
*m
, void *userdata
, sd_bus_error
*ret_error
) {
46 sd_event
*e
= userdata
;
51 sd_bus_close(sd_bus_message_get_bus(m
));
57 int bus_async_unregister_and_exit(sd_event
*e
, sd_bus
*bus
, const char *name
) {
66 /* We unregister the name here and then wait for the
67 * NameOwnerChanged signal for this event to arrive before we
68 * quit. We do this in order to make sure that any queued
69 * requests are still processed before we really exit. */
71 r
= sd_bus_get_unique_name(bus
, &unique
);
76 "sender='org.freedesktop.DBus',"
78 "interface='org.freedesktop.DBus',"
79 "member='NameOwnerChanged',"
80 "path='/org/freedesktop/DBus',"
82 "arg1='", unique
, "',",
85 r
= sd_bus_add_match_async(bus
, NULL
, match
, name_owner_change_callback
, NULL
, e
);
89 r
= sd_bus_release_name_async(bus
, NULL
, name
, NULL
, NULL
);
96 int bus_event_loop_with_idle(
101 check_idle_t check_idle
,
103 bool exiting
= false;
113 r
= sd_event_get_state(e
);
116 if (r
== SD_EVENT_FINISHED
)
120 idle
= check_idle(userdata
);
124 r
= sd_event_run(e
, exiting
|| !idle
? (uint64_t) -1 : timeout
);
128 if (r
== 0 && !exiting
&& idle
) {
130 r
= sd_bus_try_close(bus
);
134 /* Fallback for dbus1 connections: we
135 * unregister the name and wait for the
136 * response to come through for it */
137 if (r
== -EOPNOTSUPP
) {
139 /* Inform the service manager that we
140 * are going down, so that it will
141 * queue all further start requests,
142 * instead of assuming we are already
144 sd_notify(false, "STOPPING=1");
146 r
= bus_async_unregister_and_exit(e
, bus
, name
);
162 r
= sd_event_get_exit_code(e
, &code
);
169 int bus_name_has_owner(sd_bus
*c
, const char *name
, sd_bus_error
*error
) {
170 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*rep
= NULL
;
171 int r
, has_owner
= 0;
176 r
= sd_bus_call_method(c
,
177 "org.freedesktop.DBus",
178 "/org/freedesktop/dbus",
179 "org.freedesktop.DBus",
188 r
= sd_bus_message_read_basic(rep
, 'b', &has_owner
);
190 return sd_bus_error_set_errno(error
, r
);
195 static int check_good_user(sd_bus_message
*m
, uid_t good_user
) {
196 _cleanup_(sd_bus_creds_unrefp
) sd_bus_creds
*creds
= NULL
;
202 if (good_user
== UID_INVALID
)
205 r
= sd_bus_query_sender_creds(m
, SD_BUS_CREDS_EUID
, &creds
);
209 /* Don't trust augmented credentials for authorization */
210 assert_return((sd_bus_creds_get_augmented_mask(creds
) & SD_BUS_CREDS_EUID
) == 0, -EPERM
);
212 r
= sd_bus_creds_get_euid(creds
, &sender_uid
);
216 return sender_uid
== good_user
;
220 sd_bus_message
*call
,
223 const char **details
,
233 /* Tests non-interactively! */
235 r
= check_good_user(call
, good_user
);
239 r
= sd_bus_query_sender_privilege(call
, capability
);
246 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*request
= NULL
;
247 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
248 int authorized
= false, challenge
= false;
249 const char *sender
, **k
, **v
;
251 sender
= sd_bus_message_get_sender(call
);
255 r
= sd_bus_message_new_method_call(
258 "org.freedesktop.PolicyKit1",
259 "/org/freedesktop/PolicyKit1/Authority",
260 "org.freedesktop.PolicyKit1.Authority",
261 "CheckAuthorization");
265 r
= sd_bus_message_append(
268 "system-bus-name", 1, "name", "s", sender
,
273 r
= sd_bus_message_open_container(request
, 'a', "{ss}");
277 STRV_FOREACH_PAIR(k
, v
, details
) {
278 r
= sd_bus_message_append(request
, "{ss}", *k
, *v
);
283 r
= sd_bus_message_close_container(request
);
287 r
= sd_bus_message_append(request
, "us", 0, NULL
);
291 r
= sd_bus_call(call
->bus
, request
, 0, e
, &reply
);
293 /* Treat no PK available as access denied */
294 if (sd_bus_error_has_name(e
, SD_BUS_ERROR_SERVICE_UNKNOWN
)) {
295 sd_bus_error_free(e
);
302 r
= sd_bus_message_enter_container(reply
, 'r', "bba{ss}");
306 r
= sd_bus_message_read(reply
, "bb", &authorized
, &challenge
);
314 *_challenge
= challenge
;
325 typedef struct AsyncPolkitQuery
{
326 sd_bus_message
*request
, *reply
;
327 sd_bus_message_handler_t callback
;
333 static void async_polkit_query_free(AsyncPolkitQuery
*q
) {
338 sd_bus_slot_unref(q
->slot
);
340 if (q
->registry
&& q
->request
)
341 hashmap_remove(q
->registry
, q
->request
);
343 sd_bus_message_unref(q
->request
);
344 sd_bus_message_unref(q
->reply
);
349 static int async_polkit_callback(sd_bus_message
*reply
, void *userdata
, sd_bus_error
*error
) {
350 _cleanup_(sd_bus_error_free
) sd_bus_error error_buffer
= SD_BUS_ERROR_NULL
;
351 AsyncPolkitQuery
*q
= userdata
;
357 q
->slot
= sd_bus_slot_unref(q
->slot
);
358 q
->reply
= sd_bus_message_ref(reply
);
360 r
= sd_bus_message_rewind(q
->request
, true);
362 r
= sd_bus_reply_method_errno(q
->request
, r
, NULL
);
366 r
= q
->callback(q
->request
, q
->userdata
, &error_buffer
);
367 r
= bus_maybe_reply_error(q
->request
, r
, &error_buffer
);
370 async_polkit_query_free(q
);
377 int bus_verify_polkit_async(
378 sd_bus_message
*call
,
381 const char **details
,
385 sd_bus_error
*error
) {
388 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*pk
= NULL
;
390 const char *sender
, **k
, **v
;
391 sd_bus_message_handler_t callback
;
401 r
= check_good_user(call
, good_user
);
406 q
= hashmap_get(*registry
, call
);
408 int authorized
, challenge
;
410 /* This is the second invocation of this function, and
411 * there's already a response from polkit, let's
415 if (sd_bus_message_is_method_error(q
->reply
, NULL
)) {
416 const sd_bus_error
*e
;
418 /* Copy error from polkit reply */
419 e
= sd_bus_message_get_error(q
->reply
);
420 sd_bus_error_copy(error
, e
);
422 /* Treat no PK available as access denied */
423 if (sd_bus_error_has_name(e
, SD_BUS_ERROR_SERVICE_UNKNOWN
))
426 return -sd_bus_error_get_errno(e
);
429 r
= sd_bus_message_enter_container(q
->reply
, 'r', "bba{ss}");
431 r
= sd_bus_message_read(q
->reply
, "bb", &authorized
, &challenge
);
440 return sd_bus_error_set(error
, SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED
, "Interactive authentication required.");
446 r
= sd_bus_query_sender_privilege(call
, capability
);
453 if (sd_bus_get_current_message(call
->bus
) != call
)
456 callback
= sd_bus_get_current_handler(call
->bus
);
460 userdata
= sd_bus_get_current_userdata(call
->bus
);
462 sender
= sd_bus_message_get_sender(call
);
466 c
= sd_bus_message_get_allow_interactive_authorization(call
);
472 r
= hashmap_ensure_allocated(registry
, NULL
);
476 r
= sd_bus_message_new_method_call(
479 "org.freedesktop.PolicyKit1",
480 "/org/freedesktop/PolicyKit1/Authority",
481 "org.freedesktop.PolicyKit1.Authority",
482 "CheckAuthorization");
486 r
= sd_bus_message_append(
489 "system-bus-name", 1, "name", "s", sender
,
494 r
= sd_bus_message_open_container(pk
, 'a', "{ss}");
498 STRV_FOREACH_PAIR(k
, v
, details
) {
499 r
= sd_bus_message_append(pk
, "{ss}", *k
, *v
);
504 r
= sd_bus_message_close_container(pk
);
508 r
= sd_bus_message_append(pk
, "us", !!interactive
, NULL
);
512 q
= new0(AsyncPolkitQuery
, 1);
516 q
->request
= sd_bus_message_ref(call
);
517 q
->callback
= callback
;
518 q
->userdata
= userdata
;
520 r
= hashmap_put(*registry
, call
, q
);
522 async_polkit_query_free(q
);
526 q
->registry
= *registry
;
528 r
= sd_bus_call_async(call
->bus
, &q
->slot
, pk
, async_polkit_callback
, q
, 0);
530 async_polkit_query_free(q
);
540 void bus_verify_polkit_async_registry_free(Hashmap
*registry
) {
542 hashmap_free_with_destructor(registry
, async_polkit_query_free
);
546 int bus_check_peercred(sd_bus
*c
) {
552 fd
= sd_bus_get_fd(c
);
556 r
= getpeercred(fd
, &ucred
);
560 if (ucred
.uid
!= 0 && ucred
.uid
!= geteuid())
566 int bus_connect_system_systemd(sd_bus
**_bus
) {
567 _cleanup_(sd_bus_unrefp
) sd_bus
*bus
= NULL
;
573 return sd_bus_default_system(_bus
);
575 /* If we are root then let's talk directly to the system
576 * instance, instead of going via the bus */
578 r
= sd_bus_new(&bus
);
582 r
= sd_bus_set_address(bus
, "unix:path=/run/systemd/private");
586 r
= sd_bus_start(bus
);
588 return sd_bus_default_system(_bus
);
590 r
= bus_check_peercred(bus
);
594 *_bus
= TAKE_PTR(bus
);
599 int bus_connect_user_systemd(sd_bus
**_bus
) {
600 _cleanup_(sd_bus_unrefp
) sd_bus
*bus
= NULL
;
601 _cleanup_free_
char *ee
= NULL
;
607 e
= secure_getenv("XDG_RUNTIME_DIR");
609 return sd_bus_default_user(_bus
);
611 ee
= bus_address_escape(e
);
615 r
= sd_bus_new(&bus
);
619 bus
->address
= strjoin("unix:path=", ee
, "/systemd/private");
623 r
= sd_bus_start(bus
);
625 return sd_bus_default_user(_bus
);
627 r
= bus_check_peercred(bus
);
631 *_bus
= TAKE_PTR(bus
);
636 #define print_property(name, fmt, ...) \
639 printf(fmt "\n", __VA_ARGS__); \
641 printf("%s=" fmt "\n", name, __VA_ARGS__); \
644 int bus_print_property(const char *name
, sd_bus_message
*m
, bool value
, bool all
) {
646 const char *contents
;
652 r
= sd_bus_message_peek_type(m
, &type
, &contents
);
658 case SD_BUS_TYPE_STRING
: {
661 r
= sd_bus_message_read_basic(m
, type
, &s
);
665 if (all
|| !isempty(s
)) {
668 /* This property has a single value, so we need to take
669 * care not to print a new line, everything else is OK. */
670 good
= !strchr(s
, '\n');
671 print_property(name
, "%s", good
? s
: "[unprintable]");
677 case SD_BUS_TYPE_BOOLEAN
: {
680 r
= sd_bus_message_read_basic(m
, type
, &b
);
684 print_property(name
, "%s", yes_no(b
));
689 case SD_BUS_TYPE_UINT64
: {
692 r
= sd_bus_message_read_basic(m
, type
, &u
);
696 /* Yes, heuristics! But we can change this check
697 * should it turn out to not be sufficient */
699 if (endswith(name
, "Timestamp") || STR_IN_SET(name
, "NextElapseUSecRealtime", "LastTriggerUSec")) {
700 char timestamp
[FORMAT_TIMESTAMP_MAX
];
703 t
= format_timestamp(timestamp
, sizeof(timestamp
), u
);
705 print_property(name
, "%s", strempty(t
));
707 } else if (strstr(name
, "USec")) {
708 char timespan
[FORMAT_TIMESPAN_MAX
];
710 print_property(name
, "%s", format_timespan(timespan
, sizeof(timespan
), u
, 0));
711 } else if (streq(name
, "RestrictNamespaces")) {
712 _cleanup_free_
char *s
= NULL
;
715 if ((u
& NAMESPACE_FLAGS_ALL
) == 0)
717 else if ((u
& NAMESPACE_FLAGS_ALL
) == NAMESPACE_FLAGS_ALL
)
720 r
= namespace_flags_to_string(u
, &s
);
727 print_property(name
, "%s", result
);
729 } else if (streq(name
, "MountFlags")) {
732 result
= mount_propagation_flags_to_string(u
);
736 print_property(name
, "%s", result
);
738 } else if (STR_IN_SET(name
, "CapabilityBoundingSet", "AmbientCapabilities")) {
739 _cleanup_free_
char *s
= NULL
;
741 r
= capability_set_to_string_alloc(u
, &s
);
745 print_property(name
, "%s", s
);
747 } else if ((STR_IN_SET(name
, "CPUWeight", "StartupCPUWeight", "IOWeight", "StartupIOWeight") && u
== CGROUP_WEIGHT_INVALID
) ||
748 (STR_IN_SET(name
, "CPUShares", "StartupCPUShares") && u
== CGROUP_CPU_SHARES_INVALID
) ||
749 (STR_IN_SET(name
, "BlockIOWeight", "StartupBlockIOWeight") && u
== CGROUP_BLKIO_WEIGHT_INVALID
) ||
750 (STR_IN_SET(name
, "MemoryCurrent", "TasksCurrent") && u
== (uint64_t) -1) ||
751 (endswith(name
, "NSec") && u
== (uint64_t) -1))
753 print_property(name
, "%s", "[not set]");
755 else if ((STR_IN_SET(name
, "MemoryLow", "MemoryHigh", "MemoryMax", "MemorySwapMax", "MemoryLimit") && u
== CGROUP_LIMIT_MAX
) ||
756 (STR_IN_SET(name
, "TasksMax", "DefaultTasksMax") && u
== (uint64_t) -1) ||
757 (startswith(name
, "Limit") && u
== (uint64_t) -1) ||
758 (startswith(name
, "DefaultLimit") && u
== (uint64_t) -1))
760 print_property(name
, "%s", "infinity");
762 print_property(name
, "%"PRIu64
, u
);
767 case SD_BUS_TYPE_INT64
: {
770 r
= sd_bus_message_read_basic(m
, type
, &i
);
774 print_property(name
, "%"PRIi64
, i
);
779 case SD_BUS_TYPE_UINT32
: {
782 r
= sd_bus_message_read_basic(m
, type
, &u
);
786 if (strstr(name
, "UMask") || strstr(name
, "Mode"))
787 print_property(name
, "%04o", u
);
788 else if (streq(name
, "UID")) {
789 if (u
== UID_INVALID
)
790 print_property(name
, "%s", "[not set]");
792 print_property(name
, "%"PRIu32
, u
);
793 } else if (streq(name
, "GID")) {
794 if (u
== GID_INVALID
)
795 print_property(name
, "%s", "[not set]");
797 print_property(name
, "%"PRIu32
, u
);
799 print_property(name
, "%"PRIu32
, u
);
804 case SD_BUS_TYPE_INT32
: {
807 r
= sd_bus_message_read_basic(m
, type
, &i
);
811 print_property(name
, "%"PRIi32
, i
);
815 case SD_BUS_TYPE_DOUBLE
: {
818 r
= sd_bus_message_read_basic(m
, type
, &d
);
822 print_property(name
, "%g", d
);
826 case SD_BUS_TYPE_ARRAY
:
827 if (streq(contents
, "s")) {
831 r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_ARRAY
, contents
);
835 while ((r
= sd_bus_message_read_basic(m
, SD_BUS_TYPE_STRING
, &str
)) > 0) {
841 /* This property has multiple space-separated values, so
842 * neither spaces nor newlines can be allowed in a value. */
843 good
= str
[strcspn(str
, " \n")] == '\0';
845 printf("%s%s", first
? "" : " ", good
? str
: "[unprintable]");
852 if (first
&& all
&& !value
)
857 r
= sd_bus_message_exit_container(m
);
863 } else if (streq(contents
, "y")) {
867 r
= sd_bus_message_read_array(m
, SD_BUS_TYPE_BYTE
, (const void**) &u
, &n
);
877 for (i
= 0; i
< n
; i
++)
878 printf("%02x", u
[i
]);
885 } else if (streq(contents
, "u")) {
889 r
= sd_bus_message_read_array(m
, SD_BUS_TYPE_UINT32
, (const void**) &u
, &n
);
899 for (i
= 0; i
< n
; i
++)
900 printf("%08x", u
[i
]);
914 int bus_message_print_all_properties(
916 bus_message_print_t func
,
920 Set
**found_properties
) {
926 r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_ARRAY
, "{sv}");
930 while ((r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_DICT_ENTRY
, "sv")) > 0) {
932 const char *contents
;
934 r
= sd_bus_message_read_basic(m
, SD_BUS_TYPE_STRING
, &name
);
938 if (found_properties
) {
939 r
= set_ensure_allocated(found_properties
, &string_hash_ops
);
943 r
= set_put(*found_properties
, name
);
944 if (r
< 0 && r
!= EEXIST
)
948 if (!filter
|| strv_find(filter
, name
)) {
949 r
= sd_bus_message_peek_type(m
, NULL
, &contents
);
953 r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_VARIANT
, contents
);
958 r
= func(name
, m
, value
, all
);
960 r
= bus_print_property(name
, m
, value
, all
);
965 printf("%s=[unprintable]\n", name
);
966 /* skip what we didn't read */
967 r
= sd_bus_message_skip(m
, contents
);
972 r
= sd_bus_message_exit_container(m
);
976 r
= sd_bus_message_skip(m
, "v");
981 r
= sd_bus_message_exit_container(m
);
988 r
= sd_bus_message_exit_container(m
);
995 int bus_print_all_properties(
999 bus_message_print_t func
,
1003 Set
**found_properties
) {
1005 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
1006 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
1012 r
= sd_bus_call_method(bus
,
1015 "org.freedesktop.DBus.Properties",
1023 return bus_message_print_all_properties(reply
, func
, filter
, value
, all
, found_properties
);
1026 int bus_map_id128(sd_bus
*bus
, const char *member
, sd_bus_message
*m
, sd_bus_error
*error
, void *userdata
) {
1027 sd_id128_t
*p
= userdata
;
1032 r
= sd_bus_message_read_array(m
, SD_BUS_TYPE_BYTE
, &v
, &n
);
1039 memcpy((*p
).bytes
, v
, n
);
1046 static int map_basic(sd_bus
*bus
, const char *member
, sd_bus_message
*m
, unsigned flags
, sd_bus_error
*error
, void *userdata
) {
1050 r
= sd_bus_message_peek_type(m
, &type
, NULL
);
1056 case SD_BUS_TYPE_STRING
: {
1057 const char **p
= userdata
;
1060 r
= sd_bus_message_read_basic(m
, type
, &s
);
1067 if (flags
& BUS_MAP_STRDUP
)
1068 return free_and_strdup((char **) userdata
, s
);
1074 case SD_BUS_TYPE_ARRAY
: {
1075 _cleanup_strv_free_
char **l
= NULL
;
1076 char ***p
= userdata
;
1078 r
= bus_message_read_strv_extend(m
, &l
);
1082 return strv_free_and_replace(*p
, l
);
1085 case SD_BUS_TYPE_BOOLEAN
: {
1088 r
= sd_bus_message_read_basic(m
, type
, &b
);
1092 if (flags
& BUS_MAP_BOOLEAN_AS_BOOL
)
1093 * (bool*) userdata
= !!b
;
1095 * (int*) userdata
= b
;
1100 case SD_BUS_TYPE_INT32
:
1101 case SD_BUS_TYPE_UINT32
: {
1102 uint32_t u
, *p
= userdata
;
1104 r
= sd_bus_message_read_basic(m
, type
, &u
);
1112 case SD_BUS_TYPE_INT64
:
1113 case SD_BUS_TYPE_UINT64
: {
1114 uint64_t t
, *p
= userdata
;
1116 r
= sd_bus_message_read_basic(m
, type
, &t
);
1124 case SD_BUS_TYPE_DOUBLE
: {
1125 double d
, *p
= userdata
;
1127 r
= sd_bus_message_read_basic(m
, type
, &d
);
1138 int bus_message_map_all_properties(
1140 const struct bus_properties_map
*map
,
1142 sd_bus_error
*error
,
1150 r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_ARRAY
, "{sv}");
1154 while ((r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_DICT_ENTRY
, "sv")) > 0) {
1155 const struct bus_properties_map
*prop
;
1157 const char *contents
;
1161 r
= sd_bus_message_read_basic(m
, SD_BUS_TYPE_STRING
, &member
);
1165 for (i
= 0, prop
= NULL
; map
[i
].member
; i
++)
1166 if (streq(map
[i
].member
, member
)) {
1172 r
= sd_bus_message_peek_type(m
, NULL
, &contents
);
1176 r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_VARIANT
, contents
);
1180 v
= (uint8_t *)userdata
+ prop
->offset
;
1182 r
= prop
->set(sd_bus_message_get_bus(m
), member
, m
, error
, v
);
1184 r
= map_basic(sd_bus_message_get_bus(m
), member
, m
, flags
, error
, v
);
1188 r
= sd_bus_message_exit_container(m
);
1192 r
= sd_bus_message_skip(m
, "v");
1197 r
= sd_bus_message_exit_container(m
);
1204 return sd_bus_message_exit_container(m
);
1207 int bus_message_map_properties_changed(
1209 const struct bus_properties_map
*map
,
1211 sd_bus_error
*error
,
1215 int r
, invalidated
, i
;
1220 r
= bus_message_map_all_properties(m
, map
, flags
, error
, userdata
);
1224 r
= sd_bus_message_enter_container(m
, SD_BUS_TYPE_ARRAY
, "s");
1229 while ((r
= sd_bus_message_read_basic(m
, SD_BUS_TYPE_STRING
, &member
)) > 0)
1230 for (i
= 0; map
[i
].member
; i
++)
1231 if (streq(map
[i
].member
, member
)) {
1238 r
= sd_bus_message_exit_container(m
);
1245 int bus_map_all_properties(
1247 const char *destination
,
1249 const struct bus_properties_map
*map
,
1251 sd_bus_error
*error
,
1252 sd_bus_message
**reply
,
1255 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
;
1259 assert(destination
);
1262 assert(reply
|| (flags
& BUS_MAP_STRDUP
));
1264 r
= sd_bus_call_method(
1268 "org.freedesktop.DBus.Properties",
1276 r
= bus_message_map_all_properties(m
, map
, flags
, error
, userdata
);
1281 *reply
= sd_bus_message_ref(m
);
1286 int bus_connect_transport(BusTransport transport
, const char *host
, bool user
, sd_bus
**ret
) {
1287 _cleanup_(sd_bus_unrefp
) sd_bus
*bus
= NULL
;
1290 assert(transport
>= 0);
1291 assert(transport
< _BUS_TRANSPORT_MAX
);
1294 assert_return((transport
== BUS_TRANSPORT_LOCAL
) == !host
, -EINVAL
);
1295 assert_return(transport
== BUS_TRANSPORT_LOCAL
|| !user
, -EOPNOTSUPP
);
1297 switch (transport
) {
1299 case BUS_TRANSPORT_LOCAL
:
1301 r
= sd_bus_default_user(&bus
);
1303 if (sd_booted() <= 0) {
1304 /* Print a friendly message when the local system is actually not running systemd as PID 1. */
1305 log_error("System has not been booted with systemd as init system (PID 1). Can't operate.");
1309 r
= sd_bus_default_system(&bus
);
1313 case BUS_TRANSPORT_REMOTE
:
1314 r
= sd_bus_open_system_remote(&bus
, host
);
1317 case BUS_TRANSPORT_MACHINE
:
1318 r
= sd_bus_open_system_machine(&bus
, host
);
1322 assert_not_reached("Hmm, unknown transport type.");
1327 r
= sd_bus_set_exit_on_disconnect(bus
, true);
1331 *ret
= TAKE_PTR(bus
);
1336 int bus_connect_transport_systemd(BusTransport transport
, const char *host
, bool user
, sd_bus
**bus
) {
1339 assert(transport
>= 0);
1340 assert(transport
< _BUS_TRANSPORT_MAX
);
1343 assert_return((transport
== BUS_TRANSPORT_LOCAL
) == !host
, -EINVAL
);
1344 assert_return(transport
== BUS_TRANSPORT_LOCAL
|| !user
, -EOPNOTSUPP
);
1346 switch (transport
) {
1348 case BUS_TRANSPORT_LOCAL
:
1350 r
= bus_connect_user_systemd(bus
);
1352 if (sd_booted() <= 0) {
1353 /* Print a friendly message when the local system is actually not running systemd as PID 1. */
1354 log_error("System has not been booted with systemd as init system (PID 1). Can't operate.");
1358 r
= bus_connect_system_systemd(bus
);
1362 case BUS_TRANSPORT_REMOTE
:
1363 r
= sd_bus_open_system_remote(bus
, host
);
1366 case BUS_TRANSPORT_MACHINE
:
1367 r
= sd_bus_open_system_machine(bus
, host
);
1371 assert_not_reached("Hmm, unknown transport type.");
1377 int bus_property_get_bool(
1380 const char *interface
,
1381 const char *property
,
1382 sd_bus_message
*reply
,
1384 sd_bus_error
*error
) {
1386 int b
= *(bool*) userdata
;
1388 return sd_bus_message_append_basic(reply
, 'b', &b
);
1391 int bus_property_set_bool(
1394 const char *interface
,
1395 const char *property
,
1396 sd_bus_message
*value
,
1398 sd_bus_error
*error
) {
1402 r
= sd_bus_message_read(value
, "b", &b
);
1406 *(bool *) userdata
= !!b
;
1410 int bus_property_get_id128(
1413 const char *interface
,
1414 const char *property
,
1415 sd_bus_message
*reply
,
1417 sd_bus_error
*error
) {
1419 sd_id128_t
*id
= userdata
;
1421 if (sd_id128_is_null(*id
)) /* Add an empty array if the ID is zero */
1422 return sd_bus_message_append(reply
, "ay", 0);
1424 return sd_bus_message_append_array(reply
, 'y', id
->bytes
, 16);
1427 #if __SIZEOF_SIZE_T__ != 8
1428 int bus_property_get_size(
1431 const char *interface
,
1432 const char *property
,
1433 sd_bus_message
*reply
,
1435 sd_bus_error
*error
) {
1437 uint64_t sz
= *(size_t*) userdata
;
1439 return sd_bus_message_append_basic(reply
, 't', &sz
);
1443 #if __SIZEOF_LONG__ != 8
1444 int bus_property_get_long(
1447 const char *interface
,
1448 const char *property
,
1449 sd_bus_message
*reply
,
1451 sd_bus_error
*error
) {
1453 int64_t l
= *(long*) userdata
;
1455 return sd_bus_message_append_basic(reply
, 'x', &l
);
1458 int bus_property_get_ulong(
1461 const char *interface
,
1462 const char *property
,
1463 sd_bus_message
*reply
,
1465 sd_bus_error
*error
) {
1467 uint64_t ul
= *(unsigned long*) userdata
;
1469 return sd_bus_message_append_basic(reply
, 't', &ul
);
1473 int bus_log_parse_error(int r
) {
1474 return log_error_errno(r
, "Failed to parse bus message: %m");
1477 int bus_log_create_error(int r
) {
1478 return log_error_errno(r
, "Failed to create bus message: %m");
1482 * bus_path_encode_unique() - encode unique object path
1483 * @b: bus connection or NULL
1484 * @prefix: object path prefix
1485 * @sender_id: unique-name of client, or NULL
1486 * @external_id: external ID to be chosen by client, or NULL
1487 * @ret_path: storage for encoded object path pointer
1489 * Whenever we provide a bus API that allows clients to create and manage
1490 * server-side objects, we need to provide a unique name for these objects. If
1491 * we let the server choose the name, we suffer from a race condition: If a
1492 * client creates an object asynchronously, it cannot destroy that object until
1493 * it received the method reply. It cannot know the name of the new object,
1494 * thus, it cannot destroy it. Furthermore, it enforces a round-trip.
1496 * Therefore, many APIs allow the client to choose the unique name for newly
1497 * created objects. There're two problems to solve, though:
1498 * 1) Object names are usually defined via dbus object paths, which are
1499 * usually globally namespaced. Therefore, multiple clients must be able
1500 * to choose unique object names without interference.
1501 * 2) If multiple libraries share the same bus connection, they must be
1502 * able to choose unique object names without interference.
1503 * The first problem is solved easily by prefixing a name with the
1504 * unique-bus-name of a connection. The server side must enforce this and
1505 * reject any other name. The second problem is solved by providing unique
1506 * suffixes from within sd-bus.
1508 * This helper allows clients to create unique object-paths. It uses the
1509 * template '/prefix/sender_id/external_id' and returns the new path in
1510 * @ret_path (must be freed by the caller).
1511 * If @sender_id is NULL, the unique-name of @b is used. If @external_id is
1512 * NULL, this function allocates a unique suffix via @b (by requesting a new
1513 * cookie). If both @sender_id and @external_id are given, @b can be passed as
1516 * Returns: 0 on success, negative error code on failure.
1518 int bus_path_encode_unique(sd_bus
*b
, const char *prefix
, const char *sender_id
, const char *external_id
, char **ret_path
) {
1519 _cleanup_free_
char *sender_label
= NULL
, *external_label
= NULL
;
1520 char external_buf
[DECIMAL_STR_MAX(uint64_t)], *p
;
1523 assert_return(b
|| (sender_id
&& external_id
), -EINVAL
);
1524 assert_return(object_path_is_valid(prefix
), -EINVAL
);
1525 assert_return(ret_path
, -EINVAL
);
1528 r
= sd_bus_get_unique_name(b
, &sender_id
);
1534 xsprintf(external_buf
, "%"PRIu64
, ++b
->cookie
);
1535 external_id
= external_buf
;
1538 sender_label
= bus_label_escape(sender_id
);
1542 external_label
= bus_label_escape(external_id
);
1543 if (!external_label
)
1546 p
= strjoin(prefix
, "/", sender_label
, "/", external_label
);
1555 * bus_path_decode_unique() - decode unique object path
1556 * @path: object path to decode
1557 * @prefix: object path prefix
1558 * @ret_sender: output parameter for sender-id label
1559 * @ret_external: output parameter for external-id label
1561 * This does the reverse of bus_path_encode_unique() (see its description for
1562 * details). Both trailing labels, sender-id and external-id, are unescaped and
1563 * returned in the given output parameters (the caller must free them).
1565 * Note that this function returns 0 if the path does not match the template
1566 * (see bus_path_encode_unique()), 1 if it matched.
1568 * Returns: Negative error code on failure, 0 if the given object path does not
1569 * match the template (return parameters are set to NULL), 1 if it was
1570 * parsed successfully (return parameters contain allocated labels).
1572 int bus_path_decode_unique(const char *path
, const char *prefix
, char **ret_sender
, char **ret_external
) {
1574 char *sender
, *external
;
1576 assert(object_path_is_valid(path
));
1577 assert(object_path_is_valid(prefix
));
1579 assert(ret_external
);
1581 p
= object_path_startswith(path
, prefix
);
1584 *ret_external
= NULL
;
1591 *ret_external
= NULL
;
1595 sender
= bus_label_unescape_n(p
, q
- p
);
1596 external
= bus_label_unescape(q
+ 1);
1597 if (!sender
|| !external
) {
1603 *ret_sender
= sender
;
1604 *ret_external
= external
;
1608 int bus_property_get_rlimit(
1611 const char *interface
,
1612 const char *property
,
1613 sd_bus_message
*reply
,
1615 sd_bus_error
*error
) {
1617 const char *is_soft
;
1626 is_soft
= endswith(property
, "Soft");
1628 rl
= *(struct rlimit
**) userdata
;
1630 x
= is_soft
? rl
->rlim_cur
: rl
->rlim_max
;
1632 struct rlimit buf
= {};
1636 /* Chop off "Soft" suffix */
1637 s
= is_soft
? strndupa(property
, is_soft
- property
) : property
;
1639 /* Skip over any prefix, such as "Default" */
1640 assert_se(p
= strstr(s
, "Limit"));
1642 z
= rlimit_from_string(p
+ 5);
1645 (void) getrlimit(z
, &buf
);
1646 x
= is_soft
? buf
.rlim_cur
: buf
.rlim_max
;
1649 /* rlim_t might have different sizes, let's map RLIMIT_INFINITY to (uint64_t) -1, so that it is the same on all
1651 u
= x
== RLIM_INFINITY
? (uint64_t) -1 : (uint64_t) x
;
1653 return sd_bus_message_append(reply
, "t", u
);
1656 int bus_track_add_name_many(sd_bus_track
*t
, char **l
) {
1662 /* Continues adding after failure, and returns the first failure. */
1664 STRV_FOREACH(i
, l
) {
1667 k
= sd_bus_track_add_name(t
, *i
);
1668 if (k
< 0 && r
>= 0)
1675 int bus_open_system_watch_bind_with_description(sd_bus
**ret
, const char *description
) {
1676 _cleanup_(sd_bus_unrefp
) sd_bus
*bus
= NULL
;
1682 /* Match like sd_bus_open_system(), but with the "watch_bind" feature and the Connected() signal turned on. */
1684 r
= sd_bus_new(&bus
);
1689 r
= sd_bus_set_description(bus
, description
);
1694 e
= secure_getenv("DBUS_SYSTEM_BUS_ADDRESS");
1696 e
= DEFAULT_SYSTEM_BUS_ADDRESS
;
1698 r
= sd_bus_set_address(bus
, e
);
1702 r
= sd_bus_set_bus_client(bus
, true);
1706 r
= sd_bus_set_trusted(bus
, true);
1710 r
= sd_bus_negotiate_creds(bus
, true, SD_BUS_CREDS_UID
|SD_BUS_CREDS_EUID
|SD_BUS_CREDS_EFFECTIVE_CAPS
);
1714 r
= sd_bus_set_watch_bind(bus
, true);
1718 r
= sd_bus_set_connected_signal(bus
, true);
1722 r
= sd_bus_start(bus
);
1726 *ret
= TAKE_PTR(bus
);
1731 struct request_name_data
{
1737 static int reload_dbus_handler(sd_bus_message
*m
, void *userdata
, sd_bus_error
*ret_error
) {
1738 _cleanup_free_
struct request_name_data
*data
= userdata
;
1739 const sd_bus_error
*e
;
1746 e
= sd_bus_message_get_error(m
);
1748 log_error_errno(sd_bus_error_get_errno(e
), "Failed to reload DBus configuration: %s", e
->message
);
1752 /* Here, use the default request name handler to avoid an infinite loop of reloading and requesting. */
1753 r
= sd_bus_request_name_async(sd_bus_message_get_bus(m
), NULL
, data
->name
, data
->flags
, NULL
, data
->userdata
);
1755 log_error_errno(r
, "Failed to request name: %m");
1760 static int request_name_handler_may_reload_dbus(sd_bus_message
*m
, void *userdata
, sd_bus_error
*ret_error
) {
1761 _cleanup_free_
struct request_name_data
*data
= userdata
;
1768 if (sd_bus_message_is_method_error(m
, NULL
)) {
1769 const sd_bus_error
*e
= sd_bus_message_get_error(m
);
1771 if (!sd_bus_error_has_name(e
, SD_BUS_ERROR_ACCESS_DENIED
)) {
1772 log_debug_errno(sd_bus_error_get_errno(e
),
1773 "Unable to request name, failing connection: %s",
1776 bus_enter_closing(sd_bus_message_get_bus(m
));
1780 log_debug_errno(sd_bus_error_get_errno(e
),
1781 "Unable to request name, retry after reloading DBus configuration: %s",
1784 /* If systemd-timesyncd.service enables DynamicUser= and dbus.service
1785 * started before the dynamic user is realized, then the DBus policy
1786 * about timesyncd has not been enabled yet. So, let's try to reload
1787 * DBus configuration, and after that request name again. Note that it
1788 * seems that no privileges are necessary to call the following method. */
1790 r
= sd_bus_call_method_async(
1791 sd_bus_message_get_bus(m
),
1793 "org.freedesktop.DBus",
1794 "/org/freedesktop/DBus",
1795 "org.freedesktop.DBus",
1797 reload_dbus_handler
,
1800 log_error_errno(r
, "Failed to reload DBus configuration: %m");
1801 bus_enter_closing(sd_bus_message_get_bus(m
));
1805 data
= NULL
; /* Avoid free() */
1809 r
= sd_bus_message_read(m
, "u", &ret
);
1815 case BUS_NAME_ALREADY_OWNER
:
1816 log_debug("Already owner of requested service name, ignoring.");
1819 case BUS_NAME_IN_QUEUE
:
1820 log_debug("In queue for requested service name.");
1823 case BUS_NAME_PRIMARY_OWNER
:
1824 log_debug("Successfully acquired requested service name.");
1827 case BUS_NAME_EXISTS
:
1828 log_debug("Requested service name already owned, failing connection.");
1829 bus_enter_closing(sd_bus_message_get_bus(m
));
1833 log_debug("Unexpected response from RequestName(), failing connection.");
1834 bus_enter_closing(sd_bus_message_get_bus(m
));
1838 int bus_request_name_async_may_reload_dbus(sd_bus
*bus
, sd_bus_slot
**ret_slot
, const char *name
, uint64_t flags
, void *userdata
) {
1839 struct request_name_data
*data
;
1841 data
= new0(struct request_name_data
, 1);
1846 data
->flags
= flags
;
1847 data
->userdata
= userdata
;
1849 return sd_bus_request_name_async(bus
, ret_slot
, name
, flags
, request_name_handler_may_reload_dbus
, data
);
1852 int bus_reply_pair_array(sd_bus_message
*m
, char **l
) {
1853 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
1859 /* Reply to the specified message with a message containing a dictionary put together from the specified
1862 r
= sd_bus_message_new_method_return(m
, &reply
);
1866 r
= sd_bus_message_open_container(reply
, 'a', "{ss}");
1870 STRV_FOREACH_PAIR(k
, v
, l
) {
1871 r
= sd_bus_message_append(reply
, "{ss}", *k
, *v
);
1876 r
= sd_bus_message_close_container(reply
);
1880 return sd_bus_send(NULL
, reply
, NULL
);