| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-Id: <20250911073239.579643-1-409411716@gms.tku.edu.tw>
Date: Thu, 11 Sep 2025 15:32:39 +0800
From: Guan-Chun Wu <409411716@....tku.edu.tw>
To: kbusch@...nel.org,
axboe@...nel.dk,
hch@....de,
sagi@...mberg.me,
xiubli@...hat.com,
idryomov@...il.com,
ebiggers@...nel.org,
tytso@....edu,
jaegeuk@...nel.org,
akpm@...ux-foundation.org
Cc: visitorckw@...il.com,
home7438072@...il.com,
409411716@....tku.edu.tw,
linux-kernel@...r.kernel.org,
linux-nvme@...ts.infradead.org,
ceph-devel@...r.kernel.org,
linux-fscrypt@...r.kernel.org
Subject: [PATCH v2 3/5] lib: add KUnit tests for base64 encoding/decoding
Add a KUnit test suite for the base64 helpers. The tests exercise both
encoding and decoding, cover padded and unpadded forms per RFC 4648, and
include negative cases for malformed inputs and padding errors. The suite
also validates behavior with a caller-supplied encoding table.
In addition to functional checks, the suite includes simple microbenchmarks
which report average encode/decode latency for small (64B) and larger (1KB)
inputs. These numbers are informational only and do not gate the tests.
Kconfig (BASE64_KUNIT) and lib/tests/Makefile are updated accordingly.
Sample KUnit output:
KTAP version 1
# Subtest: base64
# module: base64_kunit
1..3
# base64_performance_tests: [64B] encode run : 32ns
# base64_performance_tests: [64B] decode run : 122ns
# base64_performance_tests: [1KB] encode run : 507ns
# base64_performance_tests: [1KB] decode run : 1870ns
ok 1 base64_performance_tests
ok 2 base64_encode_tests
ok 3 base64_decode_tests
# base64: pass:3 fail:0 skip:0 total:3
# Totals: pass:3 fail:0 skip:0 total:3
Signed-off-by: Guan-Chun Wu <409411716@....tku.edu.tw>
Reviewed-by: Kuan-Wei Chiu <visitorckw@...il.com>
---
lib/Kconfig.debug | 19 +++-
lib/tests/Makefile | 1 +
lib/tests/base64_kunit.c | 230 +++++++++++++++++++++++++++++++++++++++
3 files changed, 249 insertions(+), 1 deletion(-)
create mode 100644 lib/tests/base64_kunit.c
diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index dc0e0c6ed..1cfb12d02 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -2794,8 +2794,25 @@ config CMDLINE_KUNIT_TEST
If unsure, say N.
+config BASE64_KUNIT
+ tristate "KUnit test for base64 decoding and encoding" if !KUNIT_ALL_TESTS
+ depends on KUNIT
+ default KUNIT_ALL_TESTS
+ help
+ This builds the base64 unit tests.
+
+ The tests cover the encoding and decoding logic of Base64 functions
+ in the kernel.
+ In addition to correctness checks, simple performance benchmarks
+ for both encoding and decoding are also included.
+
+ For more information on KUnit and unit tests in general please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+ If unsure, say N.
+
config BITS_TEST
- tristate "KUnit test for bits.h" if !KUNIT_ALL_TESTS
+ tristate "KUnit test for bit functions and macros" if !KUNIT_ALL_TESTS
depends on KUNIT
default KUNIT_ALL_TESTS
help
diff --git a/lib/tests/Makefile b/lib/tests/Makefile
index fa6d728a8..6593a2873 100644
--- a/lib/tests/Makefile
+++ b/lib/tests/Makefile
@@ -4,6 +4,7 @@
# KUnit tests
CFLAGS_bitfield_kunit.o := $(DISABLE_STRUCTLEAK_PLUGIN)
+obj-$(CONFIG_BASE64_KUNIT) += base64_kunit.o
obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o
obj-$(CONFIG_BITS_TEST) += test_bits.o
obj-$(CONFIG_BLACKHOLE_DEV_KUNIT_TEST) += blackhole_dev_kunit.o
diff --git a/lib/tests/base64_kunit.c b/lib/tests/base64_kunit.c
new file mode 100644
index 000000000..1941ac504
--- /dev/null
+++ b/lib/tests/base64_kunit.c
@@ -0,0 +1,230 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * base64_kunit_test.c - KUnit tests for base64 encoding and decoding functions
+ *
+ * Copyright (c) 2025, Guan-Chun Wu <409411716@....tku.edu.tw>
+ */
+
+#include <kunit/test.h>
+#include <linux/base64.h>
+
+static const char base64_table[65] =
+ "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+/* ---------- Benchmark helpers ---------- */
+static u64 bench_encode_ns(const u8 *data, int len, char *dst, int reps)
+{
+ u64 t0, t1;
+
+ t0 = ktime_get_ns();
+ for (int i = 0; i < reps; i++)
+ base64_encode(data, len, dst, true, base64_table);
+ t1 = ktime_get_ns();
+
+ return div64_u64(t1 - t0, (u64)reps);
+}
+
+static u64 bench_decode_ns(const char *data, int len, u8 *dst, int reps)
+{
+ u64 t0, t1;
+
+ t0 = ktime_get_ns();
+ for (int i = 0; i < reps; i++)
+ base64_decode(data, len, dst, true, base64_table);
+ t1 = ktime_get_ns();
+
+ return div64_u64(t1 - t0, (u64)reps);
+}
+
+static void run_perf_and_check(struct kunit *test, const char *label, int size)
+{
+ const int reps = 1000;
+ size_t outlen = DIV_ROUND_UP(size, 3) * 4;
+ u8 *in = kmalloc(size, GFP_KERNEL);
+ char *enc = kmalloc(outlen, GFP_KERNEL);
+ u8 *decoded = kmalloc(size, GFP_KERNEL);
+
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, in);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, enc);
+ KUNIT_ASSERT_NOT_ERR_OR_NULL(test, decoded);
+
+ get_random_bytes(in, size);
+ int enc_len = base64_encode(in, size, enc, true, base64_table);
+ int dec_len = base64_decode(enc, enc_len, decoded, true, base64_table);
+
+ /* correctness sanity check */
+ KUNIT_EXPECT_EQ(test, dec_len, size);
+ KUNIT_EXPECT_MEMEQ(test, decoded, in, size);
+
+ /* benchmark encode */
+
+ u64 t1 = bench_encode_ns(in, size, enc, reps);
+
+ kunit_info(test, "[%s] encode run : %lluns", label, t1);
+
+ u64 t2 = bench_decode_ns(enc, enc_len, decoded, reps);
+
+ kunit_info(test, "[%s] decode run : %lluns", label, t2);
+
+ kfree(in);
+ kfree(enc);
+ kfree(decoded);
+}
+
+static void base64_performance_tests(struct kunit *test)
+{
+ run_perf_and_check(test, "64B", 64);
+ run_perf_and_check(test, "1KB", 1024);
+}
+
+/* ---------- Helpers for encode ---------- */
+static void expect_encode_ok(struct kunit *test, const u8 *src, int srclen,
+ const char *expected, bool padding)
+{
+ char buf[128];
+ int encoded_len = base64_encode(src, srclen, buf, padding, base64_table);
+
+ buf[encoded_len] = '\0';
+
+ KUNIT_EXPECT_EQ(test, encoded_len, strlen(expected));
+ KUNIT_EXPECT_STREQ(test, buf, expected);
+}
+
+/* ---------- Helpers for decode ---------- */
+static void expect_decode_ok(struct kunit *test, const char *src,
+ const u8 *expected, int expected_len, bool padding)
+{
+ u8 buf[128];
+ int decoded_len = base64_decode(src, strlen(src), buf, padding, base64_table);
+
+ KUNIT_EXPECT_EQ(test, decoded_len, expected_len);
+ KUNIT_EXPECT_MEMEQ(test, buf, expected, expected_len);
+}
+
+static void expect_decode_err(struct kunit *test, const char *src,
+ int srclen, bool padding)
+{
+ u8 buf[64];
+ int decoded_len = base64_decode(src, srclen, buf, padding, base64_table);
+
+ KUNIT_EXPECT_EQ(test, decoded_len, -1);
+}
+
+/* ---------- Encode Tests ---------- */
+static void base64_encode_tests(struct kunit *test)
+{
+ /* With padding */
+ expect_encode_ok(test, (const u8 *)"", 0, "", true);
+ expect_encode_ok(test, (const u8 *)"f", 1, "Zg==", true);
+ expect_encode_ok(test, (const u8 *)"fo", 2, "Zm8=", true);
+ expect_encode_ok(test, (const u8 *)"foo", 3, "Zm9v", true);
+ expect_encode_ok(test, (const u8 *)"foob", 4, "Zm9vYg==", true);
+ expect_encode_ok(test, (const u8 *)"fooba", 5, "Zm9vYmE=", true);
+ expect_encode_ok(test, (const u8 *)"foobar", 6, "Zm9vYmFy", true);
+
+ /* Extra cases with padding */
+ expect_encode_ok(test, (const u8 *)"Hello, world!", 13, "SGVsbG8sIHdvcmxkIQ==", true);
+ expect_encode_ok(test, (const u8 *)"ABCDEFGHIJKLMNOPQRSTUVWXYZ", 26,
+ "QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo=", true);
+ expect_encode_ok(test, (const u8 *)"abcdefghijklmnopqrstuvwxyz", 26,
+ "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=", true);
+ expect_encode_ok(test, (const u8 *)"0123456789+/", 12, "MDEyMzQ1Njc4OSsv", true);
+
+ /* Without padding */
+ expect_encode_ok(test, (const u8 *)"", 0, "", false);
+ expect_encode_ok(test, (const u8 *)"f", 1, "Zg", false);
+ expect_encode_ok(test, (const u8 *)"fo", 2, "Zm8", false);
+ expect_encode_ok(test, (const u8 *)"foo", 3, "Zm9v", false);
+ expect_encode_ok(test, (const u8 *)"foob", 4, "Zm9vYg", false);
+ expect_encode_ok(test, (const u8 *)"fooba", 5, "Zm9vYmE", false);
+ expect_encode_ok(test, (const u8 *)"foobar", 6, "Zm9vYmFy", false);
+
+ /* Extra cases without padding */
+ expect_encode_ok(test, (const u8 *)"Hello, world!", 13, "SGVsbG8sIHdvcmxkIQ", false);
+ expect_encode_ok(test, (const u8 *)"ABCDEFGHIJKLMNOPQRSTUVWXYZ", 26,
+ "QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo", false);
+ expect_encode_ok(test, (const u8 *)"abcdefghijklmnopqrstuvwxyz", 26,
+ "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo", false);
+ expect_encode_ok(test, (const u8 *)"0123456789+/", 12, "MDEyMzQ1Njc4OSsv", false);
+}
+
+/* ---------- Decode Tests ---------- */
+static void base64_decode_tests(struct kunit *test)
+{
+ /* -------- With padding --------*/
+ expect_decode_ok(test, "", (const u8 *)"", 0, true);
+ expect_decode_ok(test, "Zg==", (const u8 *)"f", 1, true);
+ expect_decode_ok(test, "Zm8=", (const u8 *)"fo", 2, true);
+ expect_decode_ok(test, "Zm9v", (const u8 *)"foo", 3, true);
+ expect_decode_ok(test, "Zm9vYg==", (const u8 *)"foob", 4, true);
+ expect_decode_ok(test, "Zm9vYmE=", (const u8 *)"fooba", 5, true);
+ expect_decode_ok(test, "Zm9vYmFy", (const u8 *)"foobar", 6, true);
+ expect_decode_ok(test, "SGVsbG8sIHdvcmxkIQ==", (const u8 *)"Hello, world!", 13, true);
+ expect_decode_ok(test, "QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo=",
+ (const u8 *)"ABCDEFGHIJKLMNOPQRSTUVWXYZ", 26, true);
+ expect_decode_ok(test, "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=",
+ (const u8 *)"abcdefghijklmnopqrstuvwxyz", 26, true);
+
+ /* Error cases */
+ expect_decode_err(test, "Zg=!", 4, true);
+ expect_decode_err(test, "Zm$=", 4, true);
+ expect_decode_err(test, "Z===", 4, true);
+ expect_decode_err(test, "Zg", 2, true);
+ expect_decode_err(test, "Zm9v====", 8, true);
+ expect_decode_err(test, "Zm==A", 5, true);
+
+ {
+ char with_nul[4] = { 'Z', 'g', '\0', '=' };
+
+ expect_decode_err(test, with_nul, 4, true);
+ }
+
+ /* -------- Without padding --------*/
+ expect_decode_ok(test, "", (const u8 *)"", 0, false);
+ expect_decode_ok(test, "Zg", (const u8 *)"f", 1, false);
+ expect_decode_ok(test, "Zm8", (const u8 *)"fo", 2, false);
+ expect_decode_ok(test, "Zm9v", (const u8 *)"foo", 3, false);
+ expect_decode_ok(test, "Zm9vYg", (const u8 *)"foob", 4, false);
+ expect_decode_ok(test, "Zm9vYmE", (const u8 *)"fooba", 5, false);
+ expect_decode_ok(test, "Zm9vYmFy", (const u8 *)"foobar", 6, false);
+ expect_decode_ok(test, "TWFu", (const u8 *)"Man", 3, false);
+ expect_decode_ok(test, "SGVsbG8sIHdvcmxkIQ", (const u8 *)"Hello, world!", 13, false);
+ expect_decode_ok(test, "QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVo",
+ (const u8 *)"ABCDEFGHIJKLMNOPQRSTUVWXYZ", 26, false);
+ expect_decode_ok(test, "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo",
+ (const u8 *)"abcdefghijklmnopqrstuvwxyz", 26, false);
+ expect_decode_ok(test, "MDEyMzQ1Njc4OSsv", (const u8 *)"0123456789+/", 12, false);
+
+ /* Error cases */
+ expect_decode_err(test, "Zg=!", 4, false);
+ expect_decode_err(test, "Zm$=", 4, false);
+ expect_decode_err(test, "Z===", 4, false);
+ expect_decode_err(test, "Zg=", 3, false);
+ expect_decode_err(test, "Zm9v====", 8, false);
+ expect_decode_err(test, "Zm==v", 4, false);
+
+ {
+ char with_nul[4] = { 'Z', 'g', '\0', '=' };
+
+ expect_decode_err(test, with_nul, 4, false);
+ }
+}
+
+/* ---------- Test registration ---------- */
+static struct kunit_case base64_test_cases[] = {
+ KUNIT_CASE(base64_performance_tests),
+ KUNIT_CASE(base64_encode_tests),
+ KUNIT_CASE(base64_decode_tests),
+ {}
+};
+
+static struct kunit_suite base64_test_suite = {
+ .name = "base64",
+ .test_cases = base64_test_cases,
+};
+
+kunit_test_suite(base64_test_suite);
+
+MODULE_AUTHOR("Guan-Chun Wu <409411716@....tku.edu.tw>");
+MODULE_DESCRIPTION("KUnit tests for Base64 encoding/decoding, including performance checks");
+MODULE_LICENSE("GPL");
--
2.34.1
Powered by blists - more mailing lists