src/test/test-id128.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include <fcntl.h>
   4 #include <sys/types.h>
   5 #include <unistd.h>
   6
   7 #include "sd-daemon.h"
   8 #include "sd-id128.h"
   9
  10 #include "alloc-util.h"
  11 #include "fd-util.h"
  12 #include "id128-util.h"
  13 #include "macro.h"
  14 #include "path-util.h"
  15 #include "rm-rf.h"
  16 #include "string-util.h"
  17 #include "tests.h"
  18 #include "tmpfile-util.h"
  19
  20 #define ID128_WALDI SD_ID128_MAKE(01, 02, 03, 04, 05, 06, 07, 08, 09, 0a, 0b, 0c, 0d, 0e, 0f, 10)
  21 #define STR_WALDI "0102030405060708090a0b0c0d0e0f10"
  22 #define UUID_WALDI "01020304-0506-0708-090a-0b0c0d0e0f10"
  23 #define STR_NULL "00000000000000000000000000000000"
  24
  25 TEST(id128) {
  26         sd_id128_t id, id2;
  27         char t[SD_ID128_STRING_MAX], q[SD_ID128_UUID_STRING_MAX];
  28         _cleanup_free_ char *b = NULL;
  29         _cleanup_close_ int fd = -EBADF;
  30
  31         assert_se(sd_id128_randomize(&id) == 0);
  32         printf("random: %s\n", sd_id128_to_string(id, t));
  33
  34         assert_se(sd_id128_from_string(t, &id2) == 0);
  35         assert_se(sd_id128_equal(id, id2));
  36         assert_se(sd_id128_in_set(id, id));
  37         assert_se(sd_id128_in_set(id, id2));
  38         assert_se(sd_id128_in_set(id, id2, id));
  39         assert_se(sd_id128_in_set(id, ID128_WALDI, id));
  40         assert_se(!sd_id128_in_set(id));
  41         assert_se(!sd_id128_in_set(id, ID128_WALDI));
  42         assert_se(!sd_id128_in_set(id, ID128_WALDI, ID128_WALDI));
  43
  44         if (sd_booted() > 0 && sd_id128_get_machine(NULL) >= 0) {
  45                 assert_se(sd_id128_get_machine(&id) == 0);
  46                 printf("machine: %s\n", sd_id128_to_string(id, t));
  47
  48                 assert_se(sd_id128_get_boot(&id) == 0);
  49                 printf("boot: %s\n", sd_id128_to_string(id, t));
  50         }
  51
  52         printf("waldi: %s\n", sd_id128_to_string(ID128_WALDI, t));
  53         ASSERT_STREQ(t, STR_WALDI);
  54
  55         assert_se(asprintf(&b, SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(ID128_WALDI)) == 32);
  56         printf("waldi2: %s\n", b);
  57         ASSERT_STREQ(t, b);
  58
  59         printf("waldi3: %s\n", sd_id128_to_uuid_string(ID128_WALDI, q));
  60         ASSERT_STREQ(q, UUID_WALDI);
  61
  62         b = mfree(b);
  63         assert_se(asprintf(&b, SD_ID128_UUID_FORMAT_STR, SD_ID128_FORMAT_VAL(ID128_WALDI)) == 36);
  64         printf("waldi4: %s\n", b);
  65         ASSERT_STREQ(q, b);
  66
  67         assert_se(sd_id128_from_string(STR_WALDI, &id) >= 0);
  68         assert_se(sd_id128_equal(id, ID128_WALDI));
  69
  70         assert_se(sd_id128_from_string(UUID_WALDI, &id) >= 0);
  71         assert_se(sd_id128_equal(id, ID128_WALDI));
  72
  73         assert_se(sd_id128_from_string("", &id) < 0);
  74         assert_se(sd_id128_from_string("01020304-0506-0708-090a-0b0c0d0e0f101", &id) < 0);
  75         assert_se(sd_id128_from_string("01020304-0506-0708-090a-0b0c0d0e0f10-", &id) < 0);
  76         assert_se(sd_id128_from_string("01020304-0506-0708-090a0b0c0d0e0f10", &id) < 0);
  77         assert_se(sd_id128_from_string("010203040506-0708-090a-0b0c0d0e0f10", &id) < 0);
  78
  79         assert_se(id128_from_string_nonzero(STR_WALDI, &id) == 0);
  80         assert_se(id128_from_string_nonzero(STR_NULL, &id) == -ENXIO);
  81         assert_se(id128_from_string_nonzero("01020304-0506-0708-090a-0b0c0d0e0f101", &id) < 0);
  82         assert_se(id128_from_string_nonzero("01020304-0506-0708-090a-0b0c0d0e0f10-", &id) < 0);
  83         assert_se(id128_from_string_nonzero("01020304-0506-0708-090a0b0c0d0e0f10", &id) < 0);
  84         assert_se(id128_from_string_nonzero("010203040506-0708-090a-0b0c0d0e0f10", &id) < 0);
  85
  86         assert_se(id128_is_valid(STR_WALDI));
  87         assert_se(id128_is_valid(UUID_WALDI));
  88         assert_se(!id128_is_valid(""));
  89         assert_se(!id128_is_valid("01020304-0506-0708-090a-0b0c0d0e0f101"));
  90         assert_se(!id128_is_valid("01020304-0506-0708-090a-0b0c0d0e0f10-"));
  91         assert_se(!id128_is_valid("01020304-0506-0708-090a0b0c0d0e0f10"));
  92         assert_se(!id128_is_valid("010203040506-0708-090a-0b0c0d0e0f10"));
  93
  94         fd = open_tmpfile_unlinkable(NULL, O_RDWR|O_CLOEXEC);
  95         assert_se(fd >= 0);
  96
  97         /* First, write as UUID */
  98         assert_se(sd_id128_randomize(&id) >= 0);
  99         assert_se(id128_write_fd(fd, ID128_FORMAT_UUID, id) >= 0);
 100
 101         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 102         assert_se(id128_read_fd(fd, ID128_FORMAT_PLAIN, &id2) == -EUCLEAN);
 103
 104         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 105         assert_se(id128_read_fd(fd, ID128_FORMAT_UUID, &id2) >= 0);
 106         assert_se(sd_id128_equal(id, id2));
 107
 108         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 109         assert_se(id128_read_fd(fd, ID128_FORMAT_ANY, &id2) >= 0);
 110         assert_se(sd_id128_equal(id, id2));
 111
 112         /* Second, write as plain */
 113         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 114         assert_se(ftruncate(fd, 0) >= 0);
 115
 116         assert_se(sd_id128_randomize(&id) >= 0);
 117         assert_se(id128_write_fd(fd, ID128_FORMAT_PLAIN, id) >= 0);
 118
 119         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 120         assert_se(id128_read_fd(fd, ID128_FORMAT_UUID, &id2) == -EUCLEAN);
 121
 122         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 123         assert_se(id128_read_fd(fd, ID128_FORMAT_PLAIN, &id2) >= 0);
 124         assert_se(sd_id128_equal(id, id2));
 125
 126         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 127         assert_se(id128_read_fd(fd, ID128_FORMAT_ANY, &id2) >= 0);
 128         assert_se(sd_id128_equal(id, id2));
 129
 130         /* Third, write plain without trailing newline */
 131         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 132         assert_se(ftruncate(fd, 0) >= 0);
 133
 134         assert_se(sd_id128_randomize(&id) >= 0);
 135         assert_se(write(fd, sd_id128_to_string(id, t), 32) == 32);
 136
 137         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 138         assert_se(id128_read_fd(fd, ID128_FORMAT_UUID, &id2) == -EUCLEAN);
 139
 140         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 141         assert_se(id128_read_fd(fd, ID128_FORMAT_PLAIN, &id2) >= 0);
 142         assert_se(sd_id128_equal(id, id2));
 143
 144         /* Fourth, write UUID without trailing newline */
 145         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 146         assert_se(ftruncate(fd, 0) >= 0);
 147
 148         assert_se(sd_id128_randomize(&id) >= 0);
 149         assert_se(write(fd, sd_id128_to_uuid_string(id, q), 36) == 36);
 150
 151         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 152         assert_se(id128_read_fd(fd, ID128_FORMAT_PLAIN, &id2) == -EUCLEAN);
 153
 154         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 155         assert_se(id128_read_fd(fd, ID128_FORMAT_UUID, &id2) >= 0);
 156         assert_se(sd_id128_equal(id, id2));
 157
 158         /* Fifth, tests for "uninitialized" */
 159         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 160         assert_se(ftruncate(fd, 0) >= 0);
 161         assert_se(write(fd, "uninitialized", STRLEN("uninitialized")) == STRLEN("uninitialized"));
 162         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 163         assert_se(id128_read_fd(fd, ID128_FORMAT_ANY, NULL) == -ENOPKG);
 164
 165         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 166         assert_se(ftruncate(fd, 0) >= 0);
 167         assert_se(write(fd, "uninitialized\n", STRLEN("uninitialized\n")) == STRLEN("uninitialized\n"));
 168         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 169         assert_se(id128_read_fd(fd, ID128_FORMAT_ANY, NULL) == -ENOPKG);
 170
 171         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 172         assert_se(ftruncate(fd, 0) >= 0);
 173         assert_se(write(fd, "uninitialized\nfoo", STRLEN("uninitialized\nfoo")) == STRLEN("uninitialized\nfoo"));
 174         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 175         assert_se(id128_read_fd(fd, ID128_FORMAT_ANY, NULL) == -EUCLEAN);
 176
 177         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 178         assert_se(ftruncate(fd, 0) >= 0);
 179         assert_se(write(fd, "uninit", STRLEN("uninit")) == STRLEN("uninit"));
 180         assert_se(lseek(fd, 0, SEEK_SET) == 0);
 181         assert_se(id128_read_fd(fd, ID128_FORMAT_ANY, NULL) == -EUCLEAN);
 182
 183         /* build/systemd-id128 -a f03daaeb1c334b43a732172944bf772e show 51df0b4bc3b04c9780e299b98ca373b8 */
 184         assert_se(sd_id128_get_app_specific(SD_ID128_MAKE(51,df,0b,4b,c3,b0,4c,97,80,e2,99,b9,8c,a3,73,b8),
 185                                             SD_ID128_MAKE(f0,3d,aa,eb,1c,33,4b,43,a7,32,17,29,44,bf,77,2e), &id) >= 0);
 186         assert_se(sd_id128_equal(id, SD_ID128_MAKE(1d,ee,59,54,e7,5c,4d,6f,b9,6c,c6,c0,4c,a1,8a,86)));
 187
 188         if (sd_booted() > 0 && sd_id128_get_machine(NULL) >= 0) {
 189                 assert_se(sd_id128_get_machine_app_specific(SD_ID128_MAKE(f0,3d,aa,eb,1c,33,4b,43,a7,32,17,29,44,bf,77,2e), &id) >= 0);
 190                 assert_se(sd_id128_get_machine_app_specific(SD_ID128_MAKE(f0,3d,aa,eb,1c,33,4b,43,a7,32,17,29,44,bf,77,2e), &id2) >= 0);
 191                 assert_se(sd_id128_equal(id, id2));
 192                 assert_se(sd_id128_get_machine_app_specific(SD_ID128_MAKE(51,df,0b,4b,c3,b0,4c,97,80,e2,99,b9,8c,a3,73,b8), &id2) >= 0);
 193                 assert_se(!sd_id128_equal(id, id2));
 194         }
 195
 196         /* Check return values */
 197         ASSERT_RETURN_EXPECTED_SE(sd_id128_get_app_specific(SD_ID128_ALLF, SD_ID128_NULL, &id) == -ENXIO);
 198         ASSERT_RETURN_EXPECTED_SE(sd_id128_get_app_specific(SD_ID128_NULL, SD_ID128_ALLF, &id) == 0);
 199 }
 200
 201 TEST(sd_id128_get_invocation) {
 202         sd_id128_t id;
 203         int r;
 204
 205         /* Query the invocation ID */
 206         r = sd_id128_get_invocation(&id);
 207         if (r < 0)
 208                 log_warning_errno(r, "Failed to get invocation ID, ignoring: %m");
 209         else
 210                 log_info("Invocation ID: " SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(id));
 211 }
 212
 213 TEST(benchmark_sd_id128_get_machine_app_specific) {
 214         unsigned iterations = slow_tests_enabled() ? 1000000 : 1000;
 215         usec_t t, q;
 216
 217         if (sd_id128_get_machine(NULL) < 0)
 218                 return (void) log_tests_skipped("/etc/machine-id is not initialized");
 219
 220         log_info("/* %s (%u iterations) */", __func__, iterations);
 221
 222         sd_id128_t id = ID128_WALDI, id2;
 223
 224         t = now(CLOCK_MONOTONIC);
 225
 226         for (unsigned i = 0; i < iterations; i++) {
 227                 id.qwords[1] = i;
 228
 229                 assert_se(sd_id128_get_machine_app_specific(id, &id2) >= 0);
 230         }
 231
 232         q = now(CLOCK_MONOTONIC) - t;
 233
 234         log_info("%lf μs each", (double) q / iterations);
 235 }
 236
 237 TEST(id128_at) {
 238         _cleanup_(rm_rf_physical_and_freep) char *t = NULL;
 239         _cleanup_close_ int tfd = -EBADF;
 240         _cleanup_free_ char *p = NULL;
 241         sd_id128_t id, i;
 242
 243         tfd = mkdtemp_open(NULL, O_PATH, &t);
 244         assert_se(tfd >= 0);
 245         assert_se(mkdirat(tfd, "etc", 0755) >= 0);
 246         assert_se(symlinkat("etc", tfd, "etc2") >= 0);
 247         assert_se(symlinkat("machine-id", tfd, "etc/hoge-id") >= 0);
 248
 249         assert_se(sd_id128_randomize(&id) == 0);
 250
 251         assert_se(id128_write_at(tfd, "etc/machine-id", ID128_FORMAT_PLAIN, id) >= 0);
 252         if (geteuid() == 0)
 253                 assert_se(id128_write_at(tfd, "etc/machine-id", ID128_FORMAT_PLAIN, id) >= 0);
 254         else
 255                 assert_se(id128_write_at(tfd, "etc/machine-id", ID128_FORMAT_PLAIN, id) == -EACCES);
 256         assert_se(unlinkat(tfd, "etc/machine-id", 0) >= 0);
 257         assert_se(id128_write_at(tfd, "etc2/machine-id", ID128_FORMAT_PLAIN, id) >= 0);
 258         assert_se(unlinkat(tfd, "etc/machine-id", 0) >= 0);
 259         assert_se(id128_write_at(tfd, "etc/hoge-id", ID128_FORMAT_PLAIN, id) >= 0);
 260         assert_se(unlinkat(tfd, "etc/machine-id", 0) >= 0);
 261         assert_se(id128_write_at(tfd, "etc2/hoge-id", ID128_FORMAT_PLAIN, id) >= 0);
 262
 263         /* id128_read_at() */
 264         i = SD_ID128_NULL; /* Not necessary in real code, but for testing that the id is really assigned. */
 265         assert_se(id128_read_at(tfd, "etc/machine-id", ID128_FORMAT_PLAIN, &i) >= 0);
 266         assert_se(sd_id128_equal(id, i));
 267
 268         i = SD_ID128_NULL;
 269         assert_se(id128_read_at(tfd, "etc2/machine-id", ID128_FORMAT_PLAIN, &i) >= 0);
 270         assert_se(sd_id128_equal(id, i));
 271
 272         i = SD_ID128_NULL;
 273         assert_se(id128_read_at(tfd, "etc/hoge-id", ID128_FORMAT_PLAIN, &i) >= 0);
 274         assert_se(sd_id128_equal(id, i));
 275
 276         i = SD_ID128_NULL;
 277         assert_se(id128_read_at(tfd, "etc2/hoge-id", ID128_FORMAT_PLAIN, &i) >= 0);
 278         assert_se(sd_id128_equal(id, i));
 279
 280         /* id128_read() */
 281         assert_se(p = path_join(t, "/etc/machine-id"));
 282
 283         i = SD_ID128_NULL;
 284         assert_se(id128_read(p, ID128_FORMAT_PLAIN, &i) >= 0);
 285         assert_se(sd_id128_equal(id, i));
 286
 287         free(p);
 288         assert_se(p = path_join(t, "/etc2/machine-id"));
 289
 290         i = SD_ID128_NULL;
 291         assert_se(id128_read(p, ID128_FORMAT_PLAIN, &i) >= 0);
 292         assert_se(sd_id128_equal(id, i));
 293
 294         free(p);
 295         assert_se(p = path_join(t, "/etc/hoge-id"));
 296
 297         i = SD_ID128_NULL;
 298         assert_se(id128_read(p, ID128_FORMAT_PLAIN, &i) >= 0);
 299         assert_se(sd_id128_equal(id, i));
 300
 301         free(p);
 302         assert_se(p = path_join(t, "/etc2/hoge-id"));
 303
 304         i = SD_ID128_NULL;
 305         assert_se(id128_read(p, ID128_FORMAT_PLAIN, &i) >= 0);
 306         assert_se(sd_id128_equal(id, i));
 307
 308         /* id128_get_machine_at() */
 309         i = SD_ID128_NULL;
 310         assert_se(id128_get_machine_at(tfd, &i) >= 0);
 311         assert_se(sd_id128_equal(id, i));
 312
 313         /* id128_get_machine() */
 314         i = SD_ID128_NULL;
 315         assert_se(id128_get_machine(t, &i) >= 0);
 316         assert_se(sd_id128_equal(id, i));
 317 }
 318
 319 TEST(ID128_REFUSE_NULL) {
 320         _cleanup_(rm_rf_physical_and_freep) char *t = NULL;
 321         _cleanup_close_ int tfd = -EBADF;
 322         sd_id128_t id;
 323
 324         tfd = mkdtemp_open(NULL, O_PATH, &t);
 325         assert_se(tfd >= 0);
 326
 327         assert_se(id128_write_at(tfd, "zero-id", ID128_FORMAT_PLAIN | ID128_REFUSE_NULL, (sd_id128_t) {}) == -ENOMEDIUM);
 328         assert_se(unlinkat(tfd, "zero-id", 0) >= 0);
 329         assert_se(id128_write_at(tfd, "zero-id", ID128_FORMAT_PLAIN, (sd_id128_t) {}) >= 0);
 330
 331         assert_se(sd_id128_randomize(&id) == 0);
 332         assert_se(!sd_id128_equal(id, SD_ID128_NULL));
 333         assert_se(id128_read_at(tfd, "zero-id", ID128_FORMAT_PLAIN, &id) >= 0);
 334         assert_se(sd_id128_equal(id, SD_ID128_NULL));
 335
 336         assert_se(id128_read_at(tfd, "zero-id", ID128_FORMAT_PLAIN | ID128_REFUSE_NULL, &id) == -ENOMEDIUM);
 337 }
 338
 339 DEFINE_TEST_MAIN(LOG_INFO);