/* SPDX-License-Identifier: LGPL-2.1-or-later */
#include "creds-util.h"
#include "fileio.h"
#include "format-util.h"
#include "hexdecoct.h"
#include "id128-util.h"
#include "iovec-util.h"
#include "path-util.h"
#include "rm-rf.h"
#include "tests.h"
#include "tmpfile-util.h"
#include "tpm2-util.h"
#include "user-util.h"
TEST(read_credential_strings) {
_cleanup_free_ char *x = NULL, *y = NULL, *saved = NULL, *p = NULL;
_cleanup_(rm_rf_physical_and_freep) char *tmp = NULL;
_cleanup_fclose_ FILE *f = NULL;
const char *e = getenv("CREDENTIALS_DIRECTORY");
if (e)
ASSERT_NOT_NULL(saved = strdup(e));
ASSERT_OK_ZERO(read_credential_strings_many("foo", &x, "bar", &y));
ASSERT_NULL(x);
ASSERT_NULL(y);
ASSERT_OK(mkdtemp_malloc(NULL, &tmp));
ASSERT_OK_ERRNO(setenv("CREDENTIALS_DIRECTORY", tmp, /* override= */ true));
ASSERT_OK_ZERO(read_credential_strings_many("foo", &x, "bar", &y));
ASSERT_NULL(x);
ASSERT_NULL(y);
ASSERT_NOT_NULL(p = path_join(tmp, "bar"));
ASSERT_OK(write_string_file(p, "piff", WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_AVOID_NEWLINE));
ASSERT_OK_ZERO(read_credential_strings_many("foo", &x, "bar", &y));
ASSERT_NULL(x);
ASSERT_STREQ(y, "piff");
ASSERT_OK(write_string_file(p, "paff", WRITE_STRING_FILE_TRUNCATE|WRITE_STRING_FILE_AVOID_NEWLINE));
ASSERT_OK_ZERO(read_credential_strings_many("foo", &x, "bar", &y));
ASSERT_NULL(x);
ASSERT_STREQ(y, "paff");
p = mfree(p);
ASSERT_NOT_NULL(p = path_join(tmp, "foo"));
ASSERT_OK(write_string_file(p, "knurz", WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_AVOID_NEWLINE));
ASSERT_OK(read_credential_strings_many("foo", &x, "bar", &y));
ASSERT_STREQ(x, "knurz");
ASSERT_STREQ(y, "paff");
p = mfree(p);
ASSERT_NOT_NULL(p = path_join(tmp, "bazz"));
ASSERT_NOT_NULL(f = fopen(p, "w"));
ASSERT_EQ(fwrite("x\0y", 1, 3, f), 3UL); /* embedded NUL byte should result in EBADMSG when reading back with read_credential_strings_many() */
f = safe_fclose(f);
y = mfree(y);
ASSERT_ERROR(read_credential_strings_many("bazz", &x, "bar", &y), EBADMSG);
ASSERT_STREQ(x, "knurz");
ASSERT_STREQ(y, "paff");
if (saved)
ASSERT_OK_ERRNO(setenv("CREDENTIALS_DIRECTORY", saved, /* override= */ 1));
else
ASSERT_OK_ERRNO(unsetenv("CREDENTIALS_DIRECTORY"));
}
TEST(credential_name_valid) {
char buf[NAME_MAX+2];
ASSERT_FALSE(credential_name_valid(NULL));
ASSERT_FALSE(credential_name_valid(""));
ASSERT_FALSE(credential_name_valid("."));
ASSERT_FALSE(credential_name_valid(".."));
ASSERT_FALSE(credential_name_valid("foo/bar"));
ASSERT_TRUE(credential_name_valid("foo"));
memset(buf, 'x', sizeof(buf)-1);
buf[sizeof(buf)-1] = 0;
ASSERT_FALSE(credential_name_valid(buf));
buf[sizeof(buf)-2] = 0;
ASSERT_TRUE(credential_name_valid(buf));
}
TEST(credential_glob_valid) {
char buf[NAME_MAX+2];
ASSERT_FALSE(credential_glob_valid(NULL));
ASSERT_FALSE(credential_glob_valid(""));
ASSERT_FALSE(credential_glob_valid("."));
ASSERT_FALSE(credential_glob_valid(".."));
ASSERT_FALSE(credential_glob_valid("foo/bar"));
ASSERT_TRUE(credential_glob_valid("foo"));
ASSERT_TRUE(credential_glob_valid("foo*"));
ASSERT_TRUE(credential_glob_valid("x*"));
ASSERT_TRUE(credential_glob_valid("*"));
ASSERT_FALSE(credential_glob_valid("?"));
ASSERT_FALSE(credential_glob_valid("*a"));
ASSERT_FALSE(credential_glob_valid("a?"));
ASSERT_FALSE(credential_glob_valid("a[abc]"));
ASSERT_FALSE(credential_glob_valid("a[abc]"));
memset(buf, 'x', sizeof(buf)-1);
buf[sizeof(buf)-1] = 0;
ASSERT_FALSE(credential_glob_valid(buf));
buf[sizeof(buf)-2] = 0;
ASSERT_TRUE(credential_glob_valid(buf));
buf[sizeof(buf)-2] = '*';
ASSERT_TRUE(credential_glob_valid(buf));
}
static void test_encrypt_decrypt_with(sd_id128_t mode, uid_t uid) {
static const struct iovec plaintext = CONST_IOVEC_MAKE_STRING("this is a super secret string");
int r;
if (uid_is_valid(uid))
log_notice("Running encryption/decryption test with mode " SD_ID128_FORMAT_STR " for UID " UID_FMT ".", SD_ID128_FORMAT_VAL(mode), uid);
else
log_notice("Running encryption/decryption test with mode " SD_ID128_FORMAT_STR ".", SD_ID128_FORMAT_VAL(mode));
_cleanup_(iovec_done) struct iovec encrypted = {};
r = encrypt_credential_and_warn(
mode,
"foo",
/* timestamp= */ USEC_INFINITY,
/* not_after=*/ USEC_INFINITY,
/* tpm2_device= */ NULL,
/* tpm2_hash_pcr_mask= */ 0,
/* tpm2_pubkey_path= */ NULL,
/* tpm2_pubkey_pcr_mask= */ 0,
uid,
&plaintext,
CREDENTIAL_ALLOW_NULL,
&encrypted);
if (ERRNO_IS_NEG_MACHINE_ID_UNSET(r)) {
log_notice_errno(r, "Skipping test encryption mode " SD_ID128_FORMAT_STR ", because /etc/machine-id is not initialized.", SD_ID128_FORMAT_VAL(mode));
return;
}
if (ERRNO_IS_NEG_NOT_SUPPORTED(r)) {
log_notice_errno(r, "Skipping test encryption mode " SD_ID128_FORMAT_STR ", because encrypted credentials are not supported.", SD_ID128_FORMAT_VAL(mode));
return;
}
ASSERT_OK(r);
_cleanup_(iovec_done) struct iovec decrypted = {};
r = decrypt_credential_and_warn(
"bar",
/* validate_timestamp= */ USEC_INFINITY,
/* tpm2_device= */ NULL,
/* tpm2_signature_path= */ NULL,
uid,
&encrypted,
CREDENTIAL_ALLOW_NULL,
&decrypted);
ASSERT_ERROR(r, EREMOTE); /* name didn't match */
r = decrypt_credential_and_warn(
"foo",
/* validate_timestamp= */ USEC_INFINITY,
/* tpm2_device= */ NULL,
/* tpm2_signature_path= */ NULL,
uid,
&encrypted,
CREDENTIAL_ALLOW_NULL,
&decrypted);
ASSERT_OK(r);
ASSERT_EQ(iovec_memcmp(&plaintext, &decrypted), 0);
}
static bool try_tpm2(void) {
#if HAVE_TPM2
_cleanup_(tpm2_context_unrefp) Tpm2Context *tpm2_context = NULL;
int r;
r = tpm2_context_new(/* device= */ NULL, &tpm2_context);
if (r < 0)
log_notice_errno(r, "Failed to create TPM2 context, assuming no TPM2 support or privileges: %m");
return r >= 0;
#else
return false;
#endif
}
TEST(credential_encrypt_decrypt) {
_cleanup_(rm_rf_physical_and_freep) char *d = NULL;
_cleanup_free_ char *j = NULL;
log_set_max_level(LOG_DEBUG);
test_encrypt_decrypt_with(CRED_AES256_GCM_BY_NULL, UID_INVALID);
ASSERT_OK(mkdtemp_malloc(NULL, &d));
j = path_join(d, "secret");
ASSERT_NOT_NULL(j);
const char *e = getenv("SYSTEMD_CREDENTIAL_SECRET");
_cleanup_free_ char *ec = NULL;
if (e)
ASSERT_NOT_NULL(ec = strdup(e));
ASSERT_OK_ERRNO(setenv("SYSTEMD_CREDENTIAL_SECRET", j, true));
test_encrypt_decrypt_with(CRED_AES256_GCM_BY_HOST, UID_INVALID);
test_encrypt_decrypt_with(CRED_AES256_GCM_BY_HOST_SCOPED, 0);
if (try_tpm2()) {
test_encrypt_decrypt_with(CRED_AES256_GCM_BY_TPM2_HMAC, UID_INVALID);
test_encrypt_decrypt_with(CRED_AES256_GCM_BY_HOST_AND_TPM2_HMAC, UID_INVALID);
test_encrypt_decrypt_with(CRED_AES256_GCM_BY_HOST_AND_TPM2_HMAC_SCOPED, 0);
}
if (ec)
ASSERT_OK_ERRNO(setenv("SYSTEMD_CREDENTIAL_SECRET", ec, true));
}
TEST(mime_type_matches) {
static const sd_id128_t tags[] = {
CRED_AES256_GCM_BY_HOST,
CRED_AES256_GCM_BY_HOST_SCOPED,
CRED_AES256_GCM_BY_TPM2_HMAC,
CRED_AES256_GCM_BY_TPM2_HMAC_WITH_PK,
CRED_AES256_GCM_BY_HOST_AND_TPM2_HMAC,
CRED_AES256_GCM_BY_HOST_AND_TPM2_HMAC_SCOPED,
CRED_AES256_GCM_BY_HOST_AND_TPM2_HMAC_WITH_PK,
CRED_AES256_GCM_BY_HOST_AND_TPM2_HMAC_WITH_PK_SCOPED,
CRED_AES256_GCM_BY_NULL,
};
/* Generates the right expressions for these credentials according to the shared mime-info spec */
FOREACH_ELEMENT(t, tags) {
_cleanup_free_ char *encoded = NULL;
ASSERT_OK(base64mem(t, sizeof(sd_id128_t), &encoded));
/* Validate that the size matches expectations for the 4/3 factor size increase (rounding up) */
ASSERT_EQ(strlen(encoded), DIV_ROUND_UP((128U / 8U), 3U) * 4U);
/* Cut off rounded string where the ID ends, but now round down to get rid of characters that might contain follow-up data */
encoded[128 / 6] = 0;
printf("\n", encoded);
}
}
DEFINE_TEST_MAIN(LOG_INFO);