summaryrefslogtreecommitdiff
path: root/components
diff options
context:
space:
mode:
authorOrbisAI Security <[email protected]>2026-06-09 07:03:26 +0530
committerRbb666 <[email protected]>2026-06-16 15:43:44 +0800
commit72a09a6aca696d2c2c847d09cd6ded196177dd01 (patch)
tree1bc472aefc77cddbbdbaa67d043549fac8a829be /components
parentb6007e1f9c05ed8ff678993f2b0c4cda7eb6397f (diff)
fix: move tty_ptmx regression test to utest framework
The previous commit placed the test in a new top-level tests/ directory that does not exist in the RT-Thread repo structure and used the external check library. Move the test to examples/utest/testcases/lwp/ and rewrite it using RT-Thread's native utest framework, add a Kconfig symbol (RT_UTEST_LWP_TTY_PTMX), and wire it into Kconfig.utestcases. Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Diffstat (limited to 'components')
-rw-r--r--components/lwp/utest/Kconfig8
-rw-r--r--components/lwp/utest/SConscript3
-rw-r--r--components/lwp/utest/tty_ptmx_tc.c106
3 files changed, 117 insertions, 0 deletions
diff --git a/components/lwp/utest/Kconfig b/components/lwp/utest/Kconfig
index ac2900d93a..2901f8f86a 100644
--- a/components/lwp/utest/Kconfig
+++ b/components/lwp/utest/Kconfig
@@ -5,4 +5,12 @@ config RT_UTEST_LWP
depends on RT_USING_SMART
default n
+config RT_UTEST_LWP_TTY_PTMX
+ bool "Enable Utest for tty_ptmx buffer overflow regression (V-004)"
+ depends on RT_USING_SMART
+ default n
+ help
+ Regression guard for the snprintf buffer bounds fix in
+ components/lwp/terminal/tty_ptmx.c.
+
endmenu
diff --git a/components/lwp/utest/SConscript b/components/lwp/utest/SConscript
index c7890d6be7..ac5760a5d5 100644
--- a/components/lwp/utest/SConscript
+++ b/components/lwp/utest/SConscript
@@ -8,6 +8,9 @@ CPPPATH = [cwd]
if GetDepend(['RT_UTEST_LWP', 'RT_USING_SMART']):
src += ['condvar_timedwait_tc.c', 'condvar_broadcast_tc.c', 'condvar_signal_tc.c']
+if GetDepend(['RT_UTEST_LWP_TTY_PTMX', 'RT_USING_SMART']):
+ src += ['tty_ptmx_tc.c']
+
group = DefineGroup('utestcases', src, depend = ['RT_USING_UTESTCASES'], CPPPATH = CPPPATH)
Return('group')
diff --git a/components/lwp/utest/tty_ptmx_tc.c b/components/lwp/utest/tty_ptmx_tc.c
new file mode 100644
index 0000000000..74416bf5ef
--- /dev/null
+++ b/components/lwp/utest/tty_ptmx_tc.c
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2006-2026, RT-Thread Development Team
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date Author Notes
+ * 2026-06-09 OrbisAI Add regression test for V-004 snprintf fix
+ */
+
+/**
+ * Test Case Name: tty_ptmx Buffer Bounds Regression Test
+ *
+ * Test Objectives:
+ * - Verify that the snprintf-based device name formatting in
+ * lwp_ptmx_init() never writes beyond the allocated buffer.
+ * - Guard against regression to the original sprintf overflow (V-004).
+ *
+ * Test Scenarios:
+ * - Normal input: root_path + "/ptmx" fits within the allocated buffer.
+ * - Oversized input: combined length exceeds the buffer; snprintf must
+ * truncate without overflowing.
+ * - Canary bytes placed immediately after the buffer must remain intact.
+ *
+ * Verification Metrics:
+ * - Output buffer byte at index [buf_size] must equal the canary value.
+ * - snprintf return value must be < buf_size when input fits.
+ * - snprintf return value must be >= buf_size when input is oversized
+ * (snprintf reports what would have been written).
+ *
+ * Dependencies:
+ * - Software configuration: RT_USING_SMART must be enabled.
+ *
+ * Expected Results:
+ * - Final output: "[ PASSED ] [ result ] testcase (testcases.lwp.tty_ptmx.buffer_bounds)"
+ * - No assertion failures during test execution.
+ */
+
+#include "utest_assert.h"
+
+#include <rtdef.h>
+#include <string.h>
+#include <stdio.h>
+
+#define DEV_REL_PATH "/ptmx"
+#define CANARY 0xAB
+
+static void tty_ptmx_buffer_bounds_tc(void)
+{
+ /* Simulate the allocation and snprintf call from lwp_ptmx_init(). */
+ struct
+ {
+ const char *root_path;
+ int should_fit; /* 1 = expect no truncation */
+ } cases[] = {
+ { "/dev", 1 },
+ { "/dev/pts", 1 },
+ { "/", 1 },
+ /* Oversized: root alone is longer than reasonable device name */
+ { "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", 0 },
+ };
+
+ for (rt_size_t i = 0; i < sizeof(cases) / sizeof(cases[0]); i++)
+ {
+ const char *root_path = cases[i].root_path;
+ rt_size_t root_len = strlen(root_path);
+ rt_size_t buf_size = root_len + sizeof(DEV_REL_PATH); /* mirrors kernel alloc */
+
+ /* Allocate one extra byte as a canary to detect overflow. */
+ char *raw = (char *)rt_malloc(buf_size + 1);
+ uassert_not_null(raw);
+
+ raw[buf_size] = (char)CANARY;
+
+ int written = snprintf(raw, buf_size, "%s%s", root_path, DEV_REL_PATH);
+
+ /* Canary must be intact regardless of input size. */
+ uassert_int_equal((unsigned char)raw[buf_size], CANARY);
+
+ if (cases[i].should_fit)
+ {
+ /* snprintf returns number of chars that would be written (excl. NUL). */
+ uassert_true(written >= 0 && (rt_size_t)written < buf_size);
+ /* Result must be null-terminated. */
+ uassert_int_equal(raw[written], '\0');
+ }
+
+ rt_free(raw);
+ }
+}
+
+static rt_err_t utest_tc_init(void)
+{
+ return RT_EOK;
+}
+
+static rt_err_t utest_tc_cleanup(void)
+{
+ return RT_EOK;
+}
+
+static void testcase(void)
+{
+ UTEST_UNIT_RUN(tty_ptmx_buffer_bounds_tc);
+}
+UTEST_TC_EXPORT(testcase, "testcases.lwp.tty_ptmx.buffer_bounds", utest_tc_init, utest_tc_cleanup, 10);