HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

src/libsystemd/sd-journal/test-journal-verify.c

11,158 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: fc459e30412d5907d5d43857f0060da101286295

Lines 1–294 of 294

/* SPDX-License-Identifier: LGPL-2.1-or-later */
 
#include <fcntl.h>
#include <stdio.h>
#include <sys/stat.h>
#include <unistd.h>
 
#include "ansi-color.h"
#include "chattr-util.h"
#include "fd-util.h"
#include "iovec-util.h"
#include "journal-authenticate.h"
#include "journal-file-util.h"
#include "journal-verify.h"
#include "log.h"
#include "mmap-cache.h"
#include "rm-rf.h"
#include "stdio-util.h"
#include "tests.h"
#include "time-util.h"
 
#define N_ENTRIES 6000
#define RANDOM_RANGE 77
 
static void bit_toggle(const char *fn, uint64_t p) {
        uint8_t b;
        int fd;
 
        ASSERT_OK_ERRNO(fd = open(fn, O_RDWR|O_CLOEXEC));
 
        ASSERT_EQ(pread(fd, &b, 1, p/8), 1);
 
        b ^= 1 << (p % 8);
 
        ASSERT_EQ(pwrite(fd, &b, 1, p/8), 1);
 
        safe_close(fd);
}
 
static int raw_verify(const char *fn, const char *verification_key) {
        _cleanup_(mmap_cache_unrefp) MMapCache *m = NULL;
        JournalFile *f;
        int r;
 
        ASSERT_NOT_NULL(m = mmap_cache_new());
 
        r = journal_file_open(
                        /* fd= */ -EBADF,
                        fn,
                        O_RDONLY,
                        JOURNAL_COMPRESS|(verification_key ? JOURNAL_SEAL : 0),
                        0666,
                        /* compress_threshold_bytes= */ UINT64_MAX,
                        /* metrics= */ NULL,
                        m,
                        /* template= */ NULL,
                        &f);
        if (r < 0)
                return r;
 
        r = journal_file_verify(f, verification_key, NULL, NULL, NULL, false);
        (void) journal_file_close(f);
 
        return r;
}
 
static int run_test(const char *verification_key, ssize_t max_iterations) {
        _cleanup_(mmap_cache_unrefp) MMapCache *m = NULL;
        char t[] = "/var/tmp/journal-XXXXXX";
        struct stat st;
        JournalFile *f;
        JournalFile *df;
        usec_t from = 0, to = 0, total = 0;
        uint64_t start, end;
        int r;
 
        ASSERT_NOT_NULL(m = mmap_cache_new());
 
        /* journal_file_open() requires a valid machine id */
        if (sd_id128_get_machine(NULL) < 0)
                return log_tests_skipped("No valid machine ID found");
 
        test_setup_logging(LOG_DEBUG);
 
        ASSERT_NOT_NULL(mkdtemp(t));
        ASSERT_OK_ERRNO(chdir(t));
        (void) chattr_path(t, FS_NOCOW_FL, FS_NOCOW_FL);
 
        log_info("Generating a test journal");
 
        ASSERT_OK_ZERO(journal_file_open(
                                /* fd= */ -EBADF,
                                "test.journal",
                                O_RDWR|O_CREAT,
                                JOURNAL_COMPRESS|(verification_key ? JOURNAL_SEAL : 0),
                                0666,
                                /* compress_threshold_bytes= */ UINT64_MAX,
                                /* metrics= */ NULL,
                                m,
                                /* template= */ NULL,
                                &df));
 
        for (size_t n = 0; n < N_ENTRIES; n++) {
                _cleanup_free_ char *test = NULL;
                struct iovec iovec;
                struct dual_timestamp ts;
 
                dual_timestamp_now(&ts);
                ASSERT_OK_ERRNO(asprintf(&test, "RANDOM=%li", random() % RANDOM_RANGE));
                iovec = IOVEC_MAKE_STRING(test);
                ASSERT_OK_ZERO(journal_file_append_entry(
                                        df,
                                        &ts,
                                        /* boot_id= */ NULL,
                                        &iovec,
                                        /* n_iovec= */ 1,
                                        /* seqnum= */ NULL,
                                        /* seqnum_id= */ NULL,
                                        /* ret_object= */ NULL,
                                        /* ret_offset= */ NULL));
        }
 
        (void) journal_file_offline_close(df);
 
        log_info("Verifying with key: %s", strna(verification_key));
 
        ASSERT_OK_ZERO(journal_file_open(
                                /* fd= */ -EBADF,
                                "test.journal",
                                O_RDONLY,
                                JOURNAL_COMPRESS|(verification_key ? JOURNAL_SEAL : 0),
                                0666,
                                /* compress_threshold_bytes= */ UINT64_MAX,
                                /* metrics= */ NULL,
                                m,
                                /* template= */ NULL,
                                &f));
        journal_file_print_header(f);
        journal_file_dump(f);
 
        ASSERT_OK(journal_file_verify(f, verification_key, &from, &to, &total, true));
 
        if (verification_key && JOURNAL_HEADER_SEALED(f->header))
                log_info("=> Validated from %s to %s, %s missing",
                         FORMAT_TIMESTAMP(from),
                         FORMAT_TIMESTAMP(to),
                         FORMAT_TIMESPAN(total > to ? total - to : 0, 0));
 
        (void) journal_file_close(f);
        ASSERT_OK_ERRNO(stat("test.journal", &st));
 
        start = 38448 * 8 + 0;
        end = max_iterations < 0 ? (uint64_t)st.st_size * 8 : start + max_iterations;
        log_info("Toggling bits %"PRIu64 " to %"PRIu64, start, end);
 
        for (uint64_t p = start; p < end; p++) {
                bit_toggle("test.journal", p);
 
                if (max_iterations < 0)
                        log_info("[ %"PRIu64"+%"PRIu64"]", p / 8, p % 8);
 
                r = raw_verify("test.journal", verification_key);
                /* Suppress the notice when running in the limited (CI) mode */
                if (verification_key && max_iterations < 0 && r >= 0)
                        log_notice(ANSI_HIGHLIGHT_RED ">>>> %"PRIu64" (bit %"PRIu64") can be toggled without detection." ANSI_NORMAL, p / 8, p % 8);
 
                bit_toggle("test.journal", p);
        }
 
        ASSERT_OK(rm_rf(t, REMOVE_ROOT|REMOVE_PHYSICAL));
 
        return 0;
}
 
static void test_hash_chain_cycle(void) {
        _cleanup_(mmap_cache_unrefp) MMapCache *m = NULL;
        char t[] = "/var/tmp/journal-XXXXXX", second[64];
        const char *first = "CYCLE=first";
        uint64_t buckets, bucket, head, tail;
        struct dual_timestamp ts;
        JournalFile *f;
        le64_t back;
        int fd;
 
        if (sd_id128_get_machine(NULL) < 0)
                return (void) log_tests_skipped("No valid machine ID found");
 
        test_setup_logging(LOG_DEBUG);
 
        ASSERT_NOT_NULL(m = mmap_cache_new());
 
        ASSERT_NOT_NULL(mkdtemp(t));
        ASSERT_OK_ERRNO(chdir(t));
 
        ASSERT_OK_ZERO(journal_file_open(
                                /* fd= */ -EBADF,
                                "test.journal",
                                O_RDWR|O_CREAT,
                                /* file_flags= */ 0,
                                0666,
                                /* compress_threshold_bytes= */ UINT64_MAX,
                                /* metrics= */ NULL,
                                m,
                                /* template= */ NULL,
                                &f));
        dual_timestamp_now(&ts);
 
        /* We need two data objects in the same hash chain. journal_file_hash_data() is keyed per-file, so
         * compute the colliding value against the open file. */
        buckets = le64toh(f->header->data_hash_table_size) / sizeof(HashItem);
        bucket = journal_file_hash_data(f, first, strlen(first)) % buckets;
        for (uint64_t i = 0;; i++) {
                ASSERT_LT(i, UINT64_C(1000000));
                xsprintf(second, "CYCLE=%" PRIu64, i);
                if (journal_file_hash_data(f, second, strlen(second)) % buckets == bucket)
                        break;
        }
 
        const char *v;
        FOREACH_ARGUMENT(v, first, second) {
                struct iovec iovec = IOVEC_MAKE_STRING(v);
                ASSERT_OK_ZERO(journal_file_append_entry(
                                        f,
                                        &ts,
                                        /* boot_id= */ NULL,
                                        &iovec,
                                        /* n_iovec= */ 1,
                                        /* seqnum= */ NULL,
                                        /* seqnum_id= */ NULL,
                                        /* ret_object= */ NULL,
                                        /* ret_offset= */ NULL));
        }
 
        ASSERT_EQ(journal_file_find_data_object(f, first, strlen(first), NULL, &head), 1);
        ASSERT_EQ(journal_file_find_data_object(f, second, strlen(second), NULL, &tail), 1);
        ASSERT_LT(head, tail);
        (void) journal_file_offline_close(f);
 
        /* The file has to be fine before we touch it, so that the failure below is really ours */
        ASSERT_OK(raw_verify("test.journal", /* verification_key= */ NULL));
 
        /* Point the second data object of the chain back at the head. Looking up the second data object,
         * which verifying the entry that references it does, would then run into the cycle. */
        back = htole64(head);
        ASSERT_OK_ERRNO(fd = open("test.journal", O_RDWR|O_CLOEXEC));
        ASSERT_EQ(pwrite(fd, &back, sizeof(back), tail + offsetof(Object, data.next_hash_offset)),
                  (ssize_t) sizeof(back));
        safe_close(fd);
 
        /* If the cycle is not detected, verification never returns. Fail quickly and visibly then, instead
         * of running into the timeout of the whole test. */
        alarm(60);
        ASSERT_ERROR(raw_verify("test.journal", /* verification_key= */ NULL), EBADMSG);
        alarm(0);
 
        ASSERT_OK(rm_rf(t, REMOVE_ROOT|REMOVE_PHYSICAL));
}
 
int main(int argc, char *argv[]) {
        const char *verification_key = NULL;
        int max_iterations = 512;
 
        journal_auth_init();
 
        if (argc > 1) {
                /* Don't limit the number of iterations when the verification key
                 * is provided on the command line, we want to do that only in CIs */
                verification_key = argv[1];
                max_iterations = -1;
        }
 
        ASSERT_OK_ERRNO(setenv("SYSTEMD_JOURNAL_COMPACT", "0", 1));
        run_test(verification_key, max_iterations);
 
        ASSERT_OK_ERRNO(setenv("SYSTEMD_JOURNAL_COMPACT", "1", 1));
        run_test(verification_key, max_iterations);
 
        /* If we're running without any arguments and journal sealing support is enabled,
         * check the journal verification stuff with a valid key as well */
        if (argc <= 1 && journal_auth_supported()) {
                verification_key = "c262bd-85187f-0b1b04-877cc5/1c7af8-35a4e900";
 
                ASSERT_OK_ERRNO(setenv("SYSTEMD_JOURNAL_COMPACT", "0", 1));
                run_test(verification_key, max_iterations);
 
                ASSERT_OK_ERRNO(setenv("SYSTEMD_JOURNAL_COMPACT", "1", 1));
                run_test(verification_key, max_iterations);
        }
 
        test_hash_chain_cycle();
 
        return 0;
}