src/libsystemd/sd-bus/test-bus-marshal.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include <math.h>
   4 #include <stdlib.h>
   5
   6 #if HAVE_GLIB
   7 #include <gio/gio.h>
   8 #endif
   9
  10 #if HAVE_DBUS
  11 #include <dbus/dbus.h>
  12 #endif
  13
  14 #include "sd-bus.h"
  15
  16 #include "alloc-util.h"
  17 #include "bus-dump.h"
  18 #include "bus-label.h"
  19 #include "bus-message.h"
  20 #include "bus-util.h"
  21 #include "escape.h"
  22 #include "fd-util.h"
  23 #include "fileio.h"
  24 #include "log.h"
  25 #include "memstream-util.h"
  26 #include "tests.h"
  27
  28 static void test_bus_path_encode_unique(void) {
  29         _cleanup_free_ char *a = NULL, *b = NULL, *c = NULL, *d = NULL, *e = NULL;
  30
  31         assert_se(bus_path_encode_unique(NULL, "/foo/bar", "some.sender", "a.suffix", &a) >= 0 && streq_ptr(a, "/foo/bar/some_2esender/a_2esuffix"));
  32         assert_se(bus_path_decode_unique(a, "/foo/bar", &b, &c) > 0 && streq_ptr(b, "some.sender") && streq_ptr(c, "a.suffix"));
  33         assert_se(bus_path_decode_unique(a, "/bar/foo", &d, &d) == 0 && !d);
  34         assert_se(bus_path_decode_unique("/foo/bar/onlyOneSuffix", "/foo/bar", &d, &d) == 0 && !d);
  35         assert_se(bus_path_decode_unique("/foo/bar/_/_", "/foo/bar", &d, &e) > 0 && streq_ptr(d, "") && streq_ptr(e, ""));
  36 }
  37
  38 static void test_bus_path_encode(void) {
  39         _cleanup_free_ char *a = NULL, *b = NULL, *c = NULL, *d = NULL, *e = NULL, *f = NULL, *g = NULL;
  40
  41         assert_se(sd_bus_path_encode("/foo/bar", "waldo", &a) >= 0 && streq(a, "/foo/bar/waldo"));
  42         assert_se(sd_bus_path_decode(a, "/waldo", &b) == 0 && b == NULL);
  43         assert_se(sd_bus_path_decode(a, "/foo/bar", &b) > 0 && streq(b, "waldo"));
  44
  45         assert_se(sd_bus_path_encode("xxxx", "waldo", &c) < 0);
  46         assert_se(sd_bus_path_encode("/foo/", "waldo", &c) < 0);
  47
  48         assert_se(sd_bus_path_encode("/foo/bar", "", &c) >= 0 && streq(c, "/foo/bar/_"));
  49         assert_se(sd_bus_path_decode(c, "/foo/bar", &d) > 0 && streq(d, ""));
  50
  51         assert_se(sd_bus_path_encode("/foo/bar", "foo.bar", &e) >= 0 && streq(e, "/foo/bar/foo_2ebar"));
  52         assert_se(sd_bus_path_decode(e, "/foo/bar", &f) > 0 && streq(f, "foo.bar"));
  53
  54         assert_se(sd_bus_path_decode("/waldo", "/waldo", &g) > 0 && streq(g, ""));
  55 }
  56
  57 static void test_bus_path_encode_many(void) {
  58         _cleanup_free_ char *a = NULL, *b = NULL, *c = NULL, *d = NULL, *e = NULL, *f = NULL;
  59
  60         assert_se(sd_bus_path_decode_many("/foo/bar", "/prefix/%", NULL) == 0);
  61         assert_se(sd_bus_path_decode_many("/prefix/bar", "/prefix/%bar", NULL) == 1);
  62         assert_se(sd_bus_path_decode_many("/foo/bar", "/prefix/%/suffix", NULL) == 0);
  63         assert_se(sd_bus_path_decode_many("/prefix/foobar/suffix", "/prefix/%/suffix", &a) == 1 && streq_ptr(a, "foobar"));
  64         assert_se(sd_bus_path_decode_many("/prefix/one_foo_two/mid/three_bar_four/suffix", "/prefix/one_%_two/mid/three_%_four/suffix", &b, &c) == 1 && streq_ptr(b, "foo") && streq_ptr(c, "bar"));
  65         assert_se(sd_bus_path_decode_many("/prefix/one_foo_two/mid/three_bar_four/suffix", "/prefix/one_%_two/mid/three_%_four/suffix", NULL, &d) == 1 && streq_ptr(d, "bar"));
  66
  67         assert_se(sd_bus_path_decode_many("/foo/bar", "/foo/bar/%", NULL) == 0);
  68         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/bar%", NULL) == 0);
  69         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/%/bar", NULL) == 0);
  70         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/%bar", NULL) == 0);
  71         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/bar/suffix") == 1);
  72         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/%%/suffix", NULL, NULL) == 0); /* multiple '%' are treated verbatim */
  73         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/%/suffi", NULL) == 0);
  74         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/%/suffix", &e) == 1 && streq_ptr(e, "bar"));
  75         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/foo/%/%", NULL, NULL) == 1);
  76         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/%/%/%", NULL, NULL, NULL) == 1);
  77         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "%/%/%", NULL, NULL, NULL) == 0);
  78         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/%/%", NULL, NULL) == 0);
  79         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/%/%/", NULL, NULL) == 0);
  80         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/%/", NULL) == 0);
  81         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "/%", NULL) == 0);
  82         assert_se(sd_bus_path_decode_many("/foo/bar/suffix", "%", NULL) == 0);
  83
  84         assert_se(sd_bus_path_encode_many(&f, "/prefix/one_%_two/mid/three_%_four/suffix", "foo", "bar") >= 0 && streq_ptr(f, "/prefix/one_foo_two/mid/three_bar_four/suffix"));
  85 }
  86
  87 static void test_bus_label_escape_one(const char *a, const char *b) {
  88         _cleanup_free_ char *t = NULL, *x = NULL, *y = NULL;
  89
  90         assert_se(t = bus_label_escape(a));
  91         assert_se(streq(t, b));
  92
  93         assert_se(x = bus_label_unescape(t));
  94         assert_se(streq(a, x));
  95
  96         assert_se(y = bus_label_unescape(b));
  97         assert_se(streq(a, y));
  98 }
  99
 100 static void test_bus_label_escape(void) {
 101         test_bus_label_escape_one("foo123bar", "foo123bar");
 102         test_bus_label_escape_one("foo.bar", "foo_2ebar");
 103         test_bus_label_escape_one("foo_2ebar", "foo_5f2ebar");
 104         test_bus_label_escape_one("", "_");
 105         test_bus_label_escape_one("_", "_5f");
 106         test_bus_label_escape_one("1", "_31");
 107         test_bus_label_escape_one(":1", "_3a1");
 108 }
 109
 110 int main(int argc, char *argv[]) {
 111         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL, *copy = NULL;
 112         _cleanup_free_ char *h = NULL, *first = NULL, *second = NULL, *third = NULL;
 113         const int32_t integer_array[] = { -1, -2, 0, 1, 2 }, *return_array;
 114         const char *x, *x2, *y, *z, *a, *b, *c, *d, *a_signature;
 115         size_t sz, first_size, second_size = 0, third_size = 0;
 116         _cleanup_(sd_bus_unrefp) sd_bus *bus = NULL;
 117         _cleanup_(memstream_done) MemStream ms = {};
 118         void *buffer = NULL;
 119         int r, boolean;
 120         uint64_t u64;
 121         uint8_t u, v;
 122         double dbl;
 123         FILE *mf;
 124         char *s;
 125
 126         test_setup_logging(LOG_INFO);
 127
 128         r = sd_bus_default_user(&bus);
 129         if (r < 0)
 130                 r = sd_bus_default_system(&bus);
 131         if (r < 0)
 132                 return log_tests_skipped("Failed to connect to bus");
 133
 134         r = sd_bus_message_new_method_call(bus, &m, "foobar.waldo", "/", "foobar.waldo", "Piep");
 135         assert_se(r >= 0);
 136
 137         r = sd_bus_message_append(m, "");
 138         assert_se(r >= 0);
 139
 140         r = sd_bus_message_append(m, "s", "a string");
 141         assert_se(r >= 0);
 142
 143         r = sd_bus_message_append(m, "s", NULL);
 144         assert_se(r >= 0);
 145
 146         r = sd_bus_message_append(m, "asg", 2, "string #1", "string #2", "sba(tt)ss");
 147         assert_se(r >= 0);
 148
 149         r = sd_bus_message_append(m, "sass", "foobar", 5, "foo", "bar", "waldo", "piep", "pap", "after");
 150         assert_se(r >= 0);
 151
 152         r = sd_bus_message_append(m, "a{yv}", 2, 3, "s", "foo", 5, "s", "waldo");
 153         assert_se(r >= 0);
 154
 155         r = sd_bus_message_append(m, "y(ty)y(yt)y", 8, 777ULL, 7, 9, 77, 7777ULL, 10);
 156         assert_se(r >= 0);
 157
 158         r = sd_bus_message_append(m, "()");
 159         assert_se(r == -EINVAL);
 160
 161         r = sd_bus_message_append(m, "ba(ss)", 255, 3, "aaa", "1", "bbb", "2", "ccc", "3");
 162         assert_se(r >= 0);
 163
 164         r = sd_bus_message_open_container(m, 'a', "s");
 165         assert_se(r >= 0);
 166
 167         r = sd_bus_message_append_basic(m, 's', "foobar");
 168         assert_se(r >= 0);
 169
 170         r = sd_bus_message_append_basic(m, 's', "waldo");
 171         assert_se(r >= 0);
 172
 173         r = sd_bus_message_close_container(m);
 174         assert_se(r >= 0);
 175
 176         r = sd_bus_message_append_string_space(m, 5, &s);
 177         assert_se(r >= 0);
 178         strcpy(s, "hallo");
 179
 180         r = sd_bus_message_append_array(m, 'i', integer_array, sizeof(integer_array));
 181         assert_se(r >= 0);
 182
 183         r = sd_bus_message_append_array(m, 'u', NULL, 0);
 184         assert_se(r >= 0);
 185
 186         r = sd_bus_message_append(m, "a(stdo)", 1, "foo", 815ULL, 47.0, "/");
 187         assert_se(r >= 0);
 188
 189         r = sd_bus_message_seal(m, 4711, 0);
 190         assert_se(r >= 0);
 191
 192         sd_bus_message_dump(m, stdout, SD_BUS_MESSAGE_DUMP_WITH_HEADER);
 193
 194         assert_se(mf = memstream_init(&ms));
 195         sd_bus_message_dump(m, mf, 0);
 196         assert_se(memstream_finalize(&ms, &first, &first_size) >= 0);
 197
 198         r = bus_message_get_blob(m, &buffer, &sz);
 199         assert_se(r >= 0);
 200
 201         h = cescape_length(buffer, sz);
 202         assert_se(h);
 203         log_info("message size = %zu, contents =\n%s", sz, h);
 204
 205 #if HAVE_GLIB
 206         /* Work-around for asan bug. See c8d980a3e962aba2ea3a4cedf75fa94890a6d746. */
 207 #if !HAS_FEATURE_ADDRESS_SANITIZER
 208         {
 209                 GDBusMessage *g;
 210                 char *p;
 211
 212 #if !defined(GLIB_VERSION_2_36)
 213                 g_type_init();
 214 #endif
 215
 216                 g = g_dbus_message_new_from_blob(buffer, sz, 0, NULL);
 217                 p = g_dbus_message_print(g, 0);
 218                 log_info("%s", p);
 219                 g_free(p);
 220                 g_object_unref(g);
 221         }
 222 #endif
 223 #endif
 224
 225 #if HAVE_DBUS
 226         {
 227                 DBusMessage *w;
 228                 DBusError error;
 229
 230                 dbus_error_init(&error);
 231
 232                 w = dbus_message_demarshal(buffer, sz, &error);
 233                 if (!w)
 234                         log_error("%s", error.message);
 235                 else
 236                         dbus_message_unref(w);
 237
 238                 dbus_error_free(&error);
 239         }
 240 #endif
 241
 242         m = sd_bus_message_unref(m);
 243
 244         r = bus_message_from_malloc(bus, buffer, sz, NULL, 0, NULL, &m);
 245         assert_se(r >= 0);
 246
 247         sd_bus_message_dump(m, stdout, SD_BUS_MESSAGE_DUMP_WITH_HEADER);
 248
 249         assert_se(mf = memstream_init(&ms));
 250         sd_bus_message_dump(m, mf, 0);
 251         assert_se(memstream_finalize(&ms, &second, &second_size) >= 0);
 252         assert_se(first_size == second_size);
 253         assert_se(memcmp(first, second, first_size) == 0);
 254
 255         assert_se(sd_bus_message_rewind(m, true) >= 0);
 256
 257         r = sd_bus_message_read(m, "ssasg", &x, &x2, 2, &y, &z, &a_signature);
 258         assert_se(r > 0);
 259         assert_se(streq(x, "a string"));
 260         assert_se(streq(x2, ""));
 261         assert_se(streq(y, "string #1"));
 262         assert_se(streq(z, "string #2"));
 263         assert_se(streq(a_signature, "sba(tt)ss"));
 264
 265         r = sd_bus_message_read(m, "sass", &x, 5, &y, &z, &a, &b, &c, &d);
 266         assert_se(r > 0);
 267         assert_se(streq(x, "foobar"));
 268         assert_se(streq(y, "foo"));
 269         assert_se(streq(z, "bar"));
 270         assert_se(streq(a, "waldo"));
 271         assert_se(streq(b, "piep"));
 272         assert_se(streq(c, "pap"));
 273         assert_se(streq(d, "after"));
 274
 275         r = sd_bus_message_read(m, "a{yv}", 2, &u, "s", &x, &v, "s", &y);
 276         assert_se(r > 0);
 277         assert_se(u == 3);
 278         assert_se(streq(x, "foo"));
 279         assert_se(v == 5);
 280         assert_se(streq(y, "waldo"));
 281
 282         r = sd_bus_message_read(m, "y(ty)", &v, &u64, &u);
 283         assert_se(r > 0);
 284         assert_se(v == 8);
 285         assert_se(u64 == 777);
 286         assert_se(u == 7);
 287
 288         r = sd_bus_message_read(m, "y(yt)", &v, &u, &u64);
 289         assert_se(r > 0);
 290         assert_se(v == 9);
 291         assert_se(u == 77);
 292         assert_se(u64 == 7777);
 293
 294         r = sd_bus_message_read(m, "y", &v);
 295         assert_se(r > 0);
 296         assert_se(v == 10);
 297
 298         r = sd_bus_message_read(m, "()");
 299         assert_se(r < 0);
 300
 301         r = sd_bus_message_read(m, "ba(ss)", &boolean, 3, &x, &y, &a, &b, &c, &d);
 302         assert_se(r > 0);
 303         assert_se(boolean);
 304         assert_se(streq(x, "aaa"));
 305         assert_se(streq(y, "1"));
 306         assert_se(streq(a, "bbb"));
 307         assert_se(streq(b, "2"));
 308         assert_se(streq(c, "ccc"));
 309         assert_se(streq(d, "3"));
 310
 311         assert_se(sd_bus_message_verify_type(m, 'a', "s") > 0);
 312
 313         r = sd_bus_message_read(m, "as", 2, &x, &y);
 314         assert_se(r > 0);
 315         assert_se(streq(x, "foobar"));
 316         assert_se(streq(y, "waldo"));
 317
 318         r = sd_bus_message_read_basic(m, 's', &s);
 319         assert_se(r > 0);
 320         assert_se(streq(s, "hallo"));
 321
 322         r = sd_bus_message_read_array(m, 'i', (const void**) &return_array, &sz);
 323         assert_se(r > 0);
 324         assert_se(sz == sizeof(integer_array));
 325         assert_se(memcmp(integer_array, return_array, sz) == 0);
 326
 327         r = sd_bus_message_read_array(m, 'u', (const void**) &return_array, &sz);
 328         assert_se(r > 0);
 329         assert_se(sz == 0);
 330
 331         r = sd_bus_message_read(m, "a(stdo)", 1, &x, &u64, &dbl, &y);
 332         assert_se(r > 0);
 333         assert_se(streq(x, "foo"));
 334         assert_se(u64 == 815ULL);
 335         assert_se(fabs(dbl - 47.0) < 0.1);
 336         assert_se(streq(y, "/"));
 337
 338         r = sd_bus_message_peek_type(m, NULL, NULL);
 339         assert_se(r == 0);
 340
 341         r = sd_bus_message_new_method_call(bus, &copy, "foobar.waldo", "/", "foobar.waldo", "Piep");
 342         assert_se(r >= 0);
 343
 344         r = sd_bus_message_rewind(m, true);
 345         assert_se(r >= 0);
 346
 347         r = sd_bus_message_copy(copy, m, true);
 348         assert_se(r >= 0);
 349
 350         r = sd_bus_message_seal(copy, 4712, 0);
 351         assert_se(r >= 0);
 352
 353         assert_se(mf = memstream_init(&ms));
 354         sd_bus_message_dump(copy, mf, 0);
 355         assert_se(memstream_finalize(&ms, &third, &third_size) >= 0);
 356
 357         printf("<%.*s>\n", (int) first_size, first);
 358         printf("<%.*s>\n", (int) third_size, third);
 359
 360         assert_se(first_size == third_size);
 361         assert_se(memcmp(first, third, third_size) == 0);
 362
 363         r = sd_bus_message_rewind(m, true);
 364         assert_se(r >= 0);
 365
 366         assert_se(sd_bus_message_verify_type(m, 's', NULL) > 0);
 367
 368         r = sd_bus_message_skip(m, "ssasg");
 369         assert_se(r > 0);
 370
 371         assert_se(sd_bus_message_verify_type(m, 's', NULL) > 0);
 372
 373         r = sd_bus_message_skip(m, "sass");
 374         assert_se(r >= 0);
 375
 376         assert_se(sd_bus_message_verify_type(m, 'a', "{yv}") > 0);
 377
 378         r = sd_bus_message_skip(m, "a{yv}y(ty)y(yt)y");
 379         assert_se(r >= 0);
 380
 381         assert_se(sd_bus_message_verify_type(m, 'b', NULL) > 0);
 382
 383         r = sd_bus_message_read(m, "b", &boolean);
 384         assert_se(r > 0);
 385         assert_se(boolean);
 386
 387         r = sd_bus_message_enter_container(m, 0, NULL);
 388         assert_se(r > 0);
 389
 390         r = sd_bus_message_read(m, "(ss)", &x, &y);
 391         assert_se(r > 0);
 392
 393         r = sd_bus_message_read(m, "(ss)", &a, &b);
 394         assert_se(r > 0);
 395
 396         r = sd_bus_message_read(m, "(ss)", &c, &d);
 397         assert_se(r > 0);
 398
 399         r = sd_bus_message_read(m, "(ss)", &x, &y);
 400         assert_se(r == 0);
 401
 402         r = sd_bus_message_exit_container(m);
 403         assert_se(r >= 0);
 404
 405         assert_se(streq(x, "aaa"));
 406         assert_se(streq(y, "1"));
 407         assert_se(streq(a, "bbb"));
 408         assert_se(streq(b, "2"));
 409         assert_se(streq(c, "ccc"));
 410         assert_se(streq(d, "3"));
 411
 412         test_bus_label_escape();
 413         test_bus_path_encode();
 414         test_bus_path_encode_unique();
 415         test_bus_path_encode_many();
 416
 417         return 0;
 418 }