blake2s_kunit.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Copyright 2025 Google LLC
 */
#include <crypto/blake2s.h>
#include "blake2s-testvecs.h"

/*
 * The following are compatibility functions that present BLAKE2s as an unkeyed
 * hash function that produces hashes of fixed length BLAKE2S_HASH_SIZE, so that
 * hash-test-template.h can be reused to test it.
 */

static void blake2s_default(const u8 *data, size_t len,
			    u8 out[BLAKE2S_HASH_SIZE])
{
	blake2s(out, data, NULL, BLAKE2S_HASH_SIZE, len, 0);
}

static void blake2s_init_default(struct blake2s_state *state)
{
	blake2s_init(state, BLAKE2S_HASH_SIZE);
}

/*
 * Generate the HASH_KUNIT_CASES using hash-test-template.h.  These test BLAKE2s
 * with a key length of 0 and a hash length of BLAKE2S_HASH_SIZE.
 */
#define HASH blake2s_default
#define HASH_CTX blake2s_state
#define HASH_SIZE BLAKE2S_HASH_SIZE
#define HASH_INIT blake2s_init_default
#define HASH_UPDATE blake2s_update
#define HASH_FINAL blake2s_final
#include "hash-test-template.h"

/*
 * BLAKE2s specific test case which tests all possible combinations of key
 * length and hash length.
 */
static void test_blake2s_all_key_and_hash_lens(struct kunit *test)
{
	const size_t data_len = 100;
	u8 *data = &test_buf[0];
	u8 *key = data + data_len;
	u8 *hash = key + BLAKE2S_KEY_SIZE;
	struct blake2s_state main_state;
	u8 main_hash[BLAKE2S_HASH_SIZE];

	rand_bytes_seeded_from_len(data, data_len);
	blake2s_init(&main_state, BLAKE2S_HASH_SIZE);
	for (int key_len = 0; key_len <= BLAKE2S_KEY_SIZE; key_len++) {
		rand_bytes_seeded_from_len(key, key_len);
		for (int out_len = 1; out_len <= BLAKE2S_HASH_SIZE; out_len++) {
			blake2s(hash, data, key, out_len, data_len, key_len);
			blake2s_update(&main_state, hash, out_len);
		}
	}
	blake2s_final(&main_state, main_hash);
	KUNIT_ASSERT_MEMEQ(test, main_hash, blake2s_keyed_testvec_consolidated,
			   BLAKE2S_HASH_SIZE);
}

/*
 * BLAKE2s specific test case which tests using a guarded buffer for all allowed
 * key lengths.  Also tests both blake2s() and blake2s_init_key().
 */
static void test_blake2s_with_guarded_key_buf(struct kunit *test)
{
	const size_t data_len = 100;

	rand_bytes(test_buf, data_len);
	for (int key_len = 0; key_len <= BLAKE2S_KEY_SIZE; key_len++) {
		u8 key[BLAKE2S_KEY_SIZE];
		u8 *guarded_key = &test_buf[TEST_BUF_LEN - key_len];
		u8 hash1[BLAKE2S_HASH_SIZE];
		u8 hash2[BLAKE2S_HASH_SIZE];
		struct blake2s_state state;

		rand_bytes(key, key_len);
		memcpy(guarded_key, key, key_len);

		blake2s(hash1, test_buf, key,
			BLAKE2S_HASH_SIZE, data_len, key_len);
		blake2s(hash2, test_buf, guarded_key,
			BLAKE2S_HASH_SIZE, data_len, key_len);
		KUNIT_ASSERT_MEMEQ(test, hash1, hash2, BLAKE2S_HASH_SIZE);

		blake2s_init_key(&state, BLAKE2S_HASH_SIZE,
				 guarded_key, key_len);
		blake2s_update(&state, test_buf, data_len);
		blake2s_final(&state, hash2);
		KUNIT_ASSERT_MEMEQ(test, hash1, hash2, BLAKE2S_HASH_SIZE);
	}
}

/*
 * BLAKE2s specific test case which tests using a guarded output buffer for all
 * allowed output lengths.
 */
static void test_blake2s_with_guarded_out_buf(struct kunit *test)
{
	const size_t data_len = 100;

	rand_bytes(test_buf, data_len);
	for (int out_len = 1; out_len <= BLAKE2S_HASH_SIZE; out_len++) {
		u8 hash[BLAKE2S_HASH_SIZE];
		u8 *guarded_hash = &test_buf[TEST_BUF_LEN - out_len];

		blake2s(hash, test_buf, NULL, out_len, data_len, 0);
		blake2s(guarded_hash, test_buf, NULL, out_len, data_len, 0);
		KUNIT_ASSERT_MEMEQ(test, hash, guarded_hash, out_len);
	}
}

static struct kunit_case blake2s_test_cases[] = {
	HASH_KUNIT_CASES,
	KUNIT_CASE(test_blake2s_all_key_and_hash_lens),
	KUNIT_CASE(test_blake2s_with_guarded_key_buf),
	KUNIT_CASE(test_blake2s_with_guarded_out_buf),
	KUNIT_CASE(benchmark_hash),
	{},
};

static struct kunit_suite blake2s_test_suite = {
	.name = "blake2s",
	.test_cases = blake2s_test_cases,
	.suite_init = hash_suite_init,
	.suite_exit = hash_suite_exit,
};
kunit_test_suite(blake2s_test_suite);

MODULE_DESCRIPTION("KUnit tests and benchmark for BLAKE2s");
MODULE_LICENSE("GPL");