From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wr1-f54.google.com (mail-wr1-f54.google.com [209.85.221.54]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 125D830648E; Mon, 1 Sep 2025 16:43:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.54 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744992; cv=none; b=bqNT54IlEIp4uurfB9LV2bZuaKntcFNxXHX1Bit44kzbmMeAUwxlbpKm5VgkIlwwhVDbYnUlRXPrfV8AF/mmFYj8nqr8lJPXefdvXEZM63Af0UGriVfIdK7QeWygDnI5TlE4yGMHZ1hy6WVRErmyQQXPcgIHM8MORDGxI5AGTa0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744992; c=relaxed/simple; bh=ycip1TAxLiNDPAGKEgXLYzfxp76jFeTeK/teHCQFpWg=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Xslu8yfH46Z1pu+Y8Ede2K08rmjTwplTK6OzLbP9lLETN6CaVuQooE89KmhclXwqraQNkUVNFQSLet7I9LT23UYICE7v98vLd3+tRXPy1y5vu7aRiIL/4xxJZdNeCxRcdjH6SIz4ZXSXcnRF7Wv3g2BOrfjP9LubYQZvr1n/KJM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=YdN6b9gO; arc=none smtp.client-ip=209.85.221.54 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="YdN6b9gO" Received: by mail-wr1-f54.google.com with SMTP id ffacd0b85a97d-3ce772ce0dbso2995298f8f.0; Mon, 01 Sep 2025 09:43:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744989; x=1757349789; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=YtywjNgEiCtG5qk+Og9zZlkfm9Zwe/MrSwR0wbY7quk=; b=YdN6b9gORyUV6jplretqUyXCa0pFj0ygNh9nWOEUxCyuUgA7GCvuiuE4HimA0QhnVL FxUEac6kdyGFVuaUOXcY+9lSvrn5TODUNpRe5MrRmEn3IsX1fSd/Ib9bptd4giMyn5Dq I8C/TXfjTRP+XOp4IzZgP7NMpf1n7Skkz/EowO9lyzxftoYPtqgunr+wRCN6sZpw6mWk /Pc4klVr3v43UXSxSTCoD4pbtf6Ihdhn8KElSvFokHOYyIoYun1hq7dqyokf+UtZQjNX ulCs5ITU9NUTxsR4m8iU1M+yivWyR2THtGC/JzcZUnzVapqdw3C4VEDNcPpWHaRLa5CT d80w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744989; x=1757349789; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=YtywjNgEiCtG5qk+Og9zZlkfm9Zwe/MrSwR0wbY7quk=; b=m5oxSo3S9SZg+Duqea365F4TMbQtymWwU53AoEnFOiwlzbSTK4Q3cte7RgQwkf7ZmM OJXejG8GOjxmr1zSKBeQUCpZa43f/hbyhD4kxE7j5zJBKUJOCOBl/A/42eTFrG0jJTOk qSU+LX8dv6ymE35VYj+X678R95hLsiCLbyn8J/qgj/VEgfIYOKXEezUvKGWMKAyTd36N ss7a4qMc2RueoubxDFxyjBOK+3b0ERAeYOIE3oTLPi67SnTiq/9GRkEdt+/tB7k2gWGG 7TAbHkuekgkuImbpQ5PykHvYPQ1SGSmjgqekWhcXBFy4R+zEpaTaWPLvM+2WEL3PrI4i E8HA== X-Forwarded-Encrypted: i=1; AJvYcCWp2LV2V0Rjxg1T50GXRBQfBEjjzV92i9Lzp7qYmb0JC3n8VatdIYraaNk/WZD4/YIMD6L30D4bpuda3Q2U@vger.kernel.org, AJvYcCX9D1aaX8WVb+A8us3EaliVCkeCjA/l4yExofe5g5Zr+WlMKQMzzulCd982oux+Z7D7175/5GYYb3e8WwU=@vger.kernel.org X-Gm-Message-State: AOJu0YyAXa5cQ4zjDqvjAYyyBwSUHVn2Kj/Ny7PbZ6q8iLSPqg1VABaz UW+3TEwFbqMud9Wr7fKHiLWylHa9JCbLxMn36thaBxJZOIkhLIz2gHGA X-Gm-Gg: ASbGncs5cZGw1iVoZO4MB/WoGHvxA4RP/SoIwS8tZ5qBn5Gr5ZHzwera350ePacq40y BtOxYYx6EFBSViWGF3mPnvkeK/tglodUtVUEVEdI5fBMHo5W9A37Kg4Xn6G3IiOiz6ZBha/tETN kWJvjpC/i1Lqcewp+f64wilKe+l4+2z8OWrM4NtyVUMRJzpl/GSuQvzd9ojd6XTa87ZlFIX9V7+ clJB8NhimmxwqI479kw1x6RoR9SF3KRq3yy9fX0QPDafKX5mmm5h0xBjrPyW+G6xFSmuTfphWN/ RuwQQoCjKnh3jbdQazowZvNB05lYoLfx4E2fiLcLGDG9CxvDC13I5A0Z9ZI+QwHoX7U0jGMRMZD t8+/bSYMYA5omrD4vb8+c8VQxrEFpyV8ZgFF+CjR/G2zjWzp059UmE4VOXgYi90z6UsEgsnEVIE sHVbNHiDICwe+dhnsQaqMXk8DWCgrS X-Google-Smtp-Source: AGHT+IEnOODGXodj9uSDYZuNbZRTIWZR+Tmr4mQZlPwEBrGOm1FTa8AUzy4RHJ1nyi0T/epc72WPkQ== X-Received: by 2002:a5d:5f50:0:b0:3ce:8632:9fed with SMTP id ffacd0b85a97d-3d1def6a9ecmr7320649f8f.45.1756744989103; Mon, 01 Sep 2025 09:43:09 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:08 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 1/7] mm/kasan: implement kasan_poison_range Date: Mon, 1 Sep 2025 16:42:06 +0000 Message-ID: <20250901164212.460229-2-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Introduce a new helper function, kasan_poison_range(), to encapsulate the logic for poisoning an arbitrary memory range of a given size, and expose it publically in . This is a preparatory change for the upcoming KFuzzTest patches, which requires the ability to poison the inter-region padding in its input buffers. No functional change to any other subsystem is intended by this commit. Signed-off-by: Ethan Graham --- include/linux/kasan.h | 16 ++++++++++++++++ mm/kasan/shadow.c | 31 +++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) diff --git a/include/linux/kasan.h b/include/linux/kasan.h index 890011071f2b..09baeb6c9f4d 100644 --- a/include/linux/kasan.h +++ b/include/linux/kasan.h @@ -102,6 +102,21 @@ static inline bool kasan_has_integrated_init(void) } =20 #ifdef CONFIG_KASAN + +/** + * kasan_poison_range - poison the memory range [start, start + size) + * + * The exact behavior is subject to alignment with KASAN_GRANULE_SIZE, def= ined + * in . + * + * - If @start is unaligned, the initial partial granule at the beginning + * of the range is only poisoned if CONFIG_KASAN_GENERIC is enabled. + * - The poisoning of the range only extends up to the last full granule b= efore + * the end of the range. Any remaining bytes in a final partial granule are + * ignored. + */ +void kasan_poison_range(const void *start, size_t size); + void __kasan_unpoison_range(const void *addr, size_t size); static __always_inline void kasan_unpoison_range(const void *addr, size_t = size) { @@ -402,6 +417,7 @@ static __always_inline bool kasan_check_byte(const void= *addr) =20 #else /* CONFIG_KASAN */ =20 +static inline void kasan_poison_range(const void *start, size_t size) {} static inline void kasan_unpoison_range(const void *address, size_t size) = {} static inline void kasan_poison_pages(struct page *page, unsigned int orde= r, bool init) {} diff --git a/mm/kasan/shadow.c b/mm/kasan/shadow.c index d2c70cd2afb1..a1b6bfb35f07 100644 --- a/mm/kasan/shadow.c +++ b/mm/kasan/shadow.c @@ -147,6 +147,37 @@ void kasan_poison(const void *addr, size_t size, u8 va= lue, bool init) } EXPORT_SYMBOL_GPL(kasan_poison); =20 +void kasan_poison_range(const void *start, size_t size) +{ + void *end =3D (char *)start + size; + uintptr_t start_addr =3D (uintptr_t)start; + uintptr_t head_granule_start; + uintptr_t poison_body_start; + uintptr_t poison_body_end; + size_t head_prefix_size; + uintptr_t end_addr; + + end_addr =3D ALIGN_DOWN((uintptr_t)end, KASAN_GRANULE_SIZE); + if (start_addr >=3D end_addr) + return; + + head_granule_start =3D ALIGN_DOWN(start_addr, KASAN_GRANULE_SIZE); + head_prefix_size =3D start_addr - head_granule_start; + + if (IS_ENABLED(CONFIG_KASAN_GENERIC) && head_prefix_size > 0) + kasan_poison_last_granule((void *)head_granule_start, + head_prefix_size); + + poison_body_start =3D ALIGN(start_addr, KASAN_GRANULE_SIZE); + poison_body_end =3D ALIGN_DOWN(end_addr, KASAN_GRANULE_SIZE); + + if (poison_body_start < poison_body_end) + kasan_poison((void *)poison_body_start, + poison_body_end - poison_body_start, + KASAN_SLAB_REDZONE, false); +} +EXPORT_SYMBOL(kasan_poison_range); + #ifdef CONFIG_KASAN_GENERIC void kasan_poison_last_granule(const void *addr, size_t size) { --=20 2.51.0.318.gd7df087d1a-goog From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wm1-f41.google.com (mail-wm1-f41.google.com [209.85.128.41]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D4B953064B8; Mon, 1 Sep 2025 16:43:12 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.41 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744995; cv=none; b=NB5oZCrxNZIrnUBhLug0MfEnVmQ/rbV7c/PFIYs+qB87x4f3kTZLBulWPOi3DUV2L5VNiqEbyuIA3czja3qeWZZMjrEjFKCNVSGUduD8XzB5f+usuCwsQKyzZr6dvNGsP/6IqrKKjDb+ZUKiRRENyuJXaoh76T1iQVgOwk/gavg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744995; c=relaxed/simple; bh=kNZUy7AE5tTwz381/3aG9uO7V7J29ML75MN00xx1u58=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=K1ldIOBQZcvDzQ+n+wJe/JmH9rO6lgCohY2zhQPlAmSEm1zVEdjdSTtAB7AbbMd5eVYIi3RqtDpWcdE0KnofTpmCCCoUy+xNREfI6L/w7xPemSjwf5FcxvEYJ8XZIyMSZ8HRnAV155Cl9EaCHg8Cq6uwpu+F2Bk5ufNw/MJqVXg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=md66KlWc; arc=none smtp.client-ip=209.85.128.41 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="md66KlWc" Received: by mail-wm1-f41.google.com with SMTP id 5b1f17b1804b1-45b873a2092so17337345e9.1; Mon, 01 Sep 2025 09:43:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744991; x=1757349791; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=BxEOD1MKRwWElbLWelALUeRCN4djFJUjaehBR9R+c+o=; b=md66KlWcEfkqQDYLZCNNNKm/+FiVDCFA9qV5HszEwpZ2+mIDwqM+kXOIpPnJXkIzjl PKxNcngjSabM6jkqHINbq2KOVQHPqLGK/iSrx3lvZzzU54FJJJ0EEoe0iwhrALDvcH+a tKuO7Z6xFkJgCVuz8pxI4HUjjV0Q9LYbwRM3YeFR6X1JQZRMU8wrSC4cQPguBYGoASjz zpqgr2cFDA/HqbdrnHpz/F1/4LrDqIxa/Ll5a3YE84SDcAS6EoVpIS6xQasMl0kb5nEI ckQ9QmF0m3b+aJPf3qqjNsgMdDEdfR2Hwg/z7Hkir58byueQdDHc+JlQ48p+o7AiEph7 4Zvw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744991; x=1757349791; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=BxEOD1MKRwWElbLWelALUeRCN4djFJUjaehBR9R+c+o=; b=WM1abRXfs5olWG+2If59c7Vgpv52ArVQk2RG3CiilS4qjMVt9F41cM8LkX+EmUbIcu 5zYwt4d6ctfOFYShMAKtzz18Ap/RGYcMt3cdr1zkmiPHSZxO4yXG2fa1XQXT3fYHTaSP d/wUU4bOKrwiyODHUbRnijyd61Vj+w7gClE5CX7S9nHwfyq4uV+96rsuEa9BP6mWf7/4 WUidRf8rlEMPgnBf+wlTR/rdyI5LfkXQtKMiSq5yKPhS20gUEjgLGEYTRABrYpaI5l3L TMGxn+xrKbdKzIyc6BBaDq309O+QHXV2bMqwtTI59D0qw71tmqPub1HRm2K63Xt+Bkxq zR5A== X-Forwarded-Encrypted: i=1; AJvYcCVYE7g5C6/rAtBvBh+6GfKUP8fXbf7gAr50pQDoadax4hU3evRZMC6/DuqfbpZj6fsT4kUpXaaG3h+kQd0=@vger.kernel.org, AJvYcCW2ThP478lTteUqeSNtryoAqyyQDwiC7go4YbdixDRvrPl+3PYYawjUVNAHAxDNI4s5c07j/JkPnftgnAwN@vger.kernel.org X-Gm-Message-State: AOJu0YyYB2qVnsBiSB0n7/FDRVpnytXHKBwGfYadJpm+PETi0F9cZYQZ bFo+TkBG2bTYCXIF+XK8V8krO38Wr5jbxiQ8wePZTw8VxgBGHDURfiu1 X-Gm-Gg: ASbGncu6i7yKvIhAjyFp86OrDVev6R1PJ9olj1SrU9z+ATvux9XZmWUxvZxQXP+LmCN 0N5P0CV6osWWgkwbrELHVooQ7ds4kZFTN0xqn9zgvZuQkoHE9VHb9wl0BGPSn0sZHLWY+yzNOiF zb936Ofa2HEzkGcShf7E3JcjlG7uIIifK1O/E1ASUQtjG7itfJYegNcGYy8ffwkKlO96foy9Sye v3wXkqxYUOTMuiMXKconr2THhS6u39t8eVTtENzx+2et411pJTz9XStiGJQ8WLNKL9SVvyP7tMg 89gyLfUbbrKAnJFAx0KeeRhkOC6k7Hl9gWCGJEEbYDen2Uwsm1HtiDbzfpbrhj/nW1HhyaQcDj0 Fo29GRUPGB10RVS0pW9DVVw0NpND/w8nM2visQJolmuI84YJGBEToS/A3Ss0jt9b8YWrSVkXHUb 8SbrmoBf8InyWGtxT+iQ== X-Google-Smtp-Source: AGHT+IEYVvCFq1A7M2tghI3KZRPRKGm+U5vsXr2UeEi/vLP4ZTkQpME7U71NM9i1fQtsbILFGPchkA== X-Received: by 2002:a05:600c:c48f:b0:45b:7c4c:cfbf with SMTP id 5b1f17b1804b1-45b855709d3mr64876485e9.23.1756744990111; Mon, 01 Sep 2025 09:43:10 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:09 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 2/7] kfuzztest: add user-facing API and data structures Date: Mon, 1 Sep 2025 16:42:07 +0000 Message-ID: <20250901164212.460229-3-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Add the foundational user-facing components for the KFuzzTest framework. This includes the main API header , the Kconfig option to enable the feature, and the required linker script changes which introduce three new ELF sections in vmlinux. Note that KFuzzTest is intended strictly for debug builds only, and should never be enabled in a production build. The fact that it exposes internal kernel functions and state directly to userspace may constitute a serious security vulnerability if used for any reason other than testing. The header defines: - The FUZZ_TEST() macro for creating test targets. - The data structures required for the binary serialization format, which allows passing complex inputs from userspace. - The metadata structures for test targets, constraints and annotations, which are placed in dedicated ELF sections (.kfuzztest_*) for discovery. This patch only adds the public interface and build integration; no runtime logic is included. Signed-off-by: Ethan Graham --- arch/x86/kernel/vmlinux.lds.S | 22 ++ include/linux/kfuzztest.h | 508 ++++++++++++++++++++++++++++++++++ lib/Kconfig.debug | 1 + lib/kfuzztest/Kconfig | 20 ++ 4 files changed, 551 insertions(+) create mode 100644 include/linux/kfuzztest.h create mode 100644 lib/kfuzztest/Kconfig diff --git a/arch/x86/kernel/vmlinux.lds.S b/arch/x86/kernel/vmlinux.lds.S index 4fa0be732af1..484e3e1ffb9f 100644 --- a/arch/x86/kernel/vmlinux.lds.S +++ b/arch/x86/kernel/vmlinux.lds.S @@ -112,6 +112,26 @@ ASSERT(__relocate_kernel_end - __relocate_kernel_start= <=3D KEXEC_CONTROL_CODE_MAX #else #define KEXEC_RELOCATE_KERNEL #endif + +#ifdef CONFIG_KFUZZTEST +#define KFUZZTEST_TABLE \ + . =3D ALIGN(PAGE_SIZE); \ + __kfuzztest_targets_start =3D .; \ + KEEP(*(.kfuzztest_target)); \ + __kfuzztest_targets_end =3D .; \ + . =3D ALIGN(PAGE_SIZE); \ + __kfuzztest_constraints_start =3D .; \ + KEEP(*(.kfuzztest_constraint)); \ + __kfuzztest_constraints_end =3D .; \ + . =3D ALIGN(PAGE_SIZE); \ + __kfuzztest_annotations_start =3D .; \ + KEEP(*(.kfuzztest_annotation)); \ + __kfuzztest_annotations_end =3D .; + +#else /* CONFIG_KFUZZTEST */ +#define KFUZZTEST_TABLE +#endif /* CONFIG_KFUZZTEST */ + PHDRS { text PT_LOAD FLAGS(5); /* R_E */ data PT_LOAD FLAGS(6); /* RW_ */ @@ -199,6 +219,8 @@ SECTIONS CONSTRUCTORS KEXEC_RELOCATE_KERNEL =20 + KFUZZTEST_TABLE + /* rarely changed data like cpu maps */ READ_MOSTLY_DATA(INTERNODE_CACHE_BYTES) =20 diff --git a/include/linux/kfuzztest.h b/include/linux/kfuzztest.h new file mode 100644 index 000000000000..11a647c1d925 --- /dev/null +++ b/include/linux/kfuzztest.h @@ -0,0 +1,508 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * The Kernel Fuzz Testing Framework (KFuzzTest) API for defining fuzz tar= gets + * for internal kernel functions. + * + * For more information please see Documentation/dev-tools/kfuzztest.rst. + * + * Copyright 2025 Google LLC + */ +#ifndef KFUZZTEST_H +#define KFUZZTEST_H + +#include +#include +#include + +#define KFUZZTEST_HEADER_MAGIC (0xBFACE) +#define KFUZZTEST_V0 (0) + +/** + * @brief The KFuzzTest Input Serialization Format + * + * KFuzzTest receives its input from userspace as a single binary blob. Th= is + * format allows for the serialization of complex, pointer-rich C structur= es + * into a flat buffer that can be safely passed into the kernel. This form= at + * requires only a single copy from userspace into a kenrel buffer, and no + * further kernel allocations. Pointers are patched internally using a "re= gion" + * system where each region corresponds to some pointed-to data. + * + * Regions should be padded to respect alignment constraints of their unde= rlying + * types, and should be followed by at least 8 bytes of padding. These pad= ded + * regions are poisoned by KFuzzTest to ensure that KASAN catches OOB acce= sses. + * + * The format consists of a prefix and three main components: + * 1. An 8-byte header: Contains KFUZZTEST_MAGIC in the first 4 bytes, and= the + * version number in the subsequent 4 bytes. This ensures backwards + * compatibility in the event of future format changes. + * 2. A reloc_region_array: Defines the memory layout of the target struct= ure + * by partitioning the payload into logical regions. Each logical region + * should contain the byte representation of the type that it represents, + * including any necessary padding. The region descriptors should be + * ordered by offset ascending. + * 3. A reloc_table: Provides "linking" instructions that tell the kernel = how + * to patch pointer fields to point to the correct regions. By design, + * the first region (index 0) is passed as input into a FUZZ_TEST. + * 4. A Payload: The raw binary data for the structure and its associated + * buffers. This should be aligned to the maximum alignment of all + * regions to satisfy alignment requirements of the input types, but this + * isn't checked by the parser. + * + * For a detailed specification of the binary layout see the full document= ation + * at: Documentation/dev-tools/kfuzztest.rst + */ + +/** + * struct reloc_region - single contiguous memory region in the payload + * + * @offset: The byte offset of this region from the start of the payload, = which + * should be aligned to the alignment requirements of the region's + * underlying type. + * @size: The size of this region in bytes. + */ +struct reloc_region { + uint32_t offset; + uint32_t size; +}; + +/** + * struct reloc_region_array - array of regions in an input + * @num_regions: The total number of regions defined. + * @regions: A flexible array of `num_regions` region descriptors. + */ +struct reloc_region_array { + uint32_t num_regions; + struct reloc_region regions[]; +}; + +/** + * struct reloc_entry - a single pointer to be patched in an input + * + * @region_id: The index of the region in the `reloc_region_array` that + * contains the pointer. + * @region_offset: The start offset of the pointer inside of the region. + * @value: contains the index of the pointee region, or KFUZZTEST_REGIONID= _NULL + * if the pointer is NULL. + */ +struct reloc_entry { + uint32_t region_id; + uint32_t region_offset; + uint32_t value; +}; + +/** + * struct reloc_entry - array of relocations required by an input + * + * @num_entries: the number of pointer relocations. + * @padding_size: the number of padded bytes between the last relocation in + * entries, and the start of the payload data. This should be at least + * 8 bytes, as it is used for poisoning. + * @entries: array of relocations. + */ +struct reloc_table { + uint32_t num_entries; + uint32_t padding_size; + struct reloc_entry entries[]; +}; + +/** + * kfuzztest_parse_and_relocate - validate and relocate a KFuzzTest input + * + * @input: A buffer containing the serialized input for a fuzz target. + * @input_size: the size in bytes of the @input buffer. + * @arg_ret: return pointer for the test case's input structure. + */ +int kfuzztest_parse_and_relocate(void *input, size_t input_size, void **ar= g_ret); + +/* + * Dump some information on the parsed headers and payload. Can be useful = for + * debugging inputs when writing an encoder for the KFuzzTest input format. + */ +__attribute__((unused)) static inline void kfuzztest_debug_header(struct r= eloc_region_array *regions, + struct reloc_table *rt, void *payload_start, + void *payload_end) +{ + uint32_t i; + + pr_info("regions: { num_regions =3D %u } @ %px", regions->num_regions, re= gions); + for (i =3D 0; i < regions->num_regions; i++) { + pr_info(" region_%u: { start: 0x%x, size: 0x%x }", i, regions->regions[= i].offset, + regions->regions[i].size); + } + + pr_info("reloc_table: { num_entries =3D %u, padding =3D %u } @ offset 0x%= lx", rt->num_entries, rt->padding_size, + (char *)rt - (char *)regions); + for (i =3D 0; i < rt->num_entries; i++) { + pr_info(" reloc_%u: { src: %u, offset: 0x%x, dst: %u }", i, rt->entries= [i].region_id, + rt->entries[i].region_offset, rt->entries[i].value); + } + + pr_info("payload: [0x%lx, 0x%lx)", (char *)payload_start - (char *)region= s, + (char *)payload_end - (char *)regions); +} + +struct kfuzztest_target { + const char *name; + const char *arg_type_name; + ssize_t (*write_input_cb)(struct file *filp, const char __user *buf, size= _t len, loff_t *off); +} __aligned(32); + +/** + * FUZZ_TEST - defines a KFuzzTest target + * + * @test_name: The unique identifier for the fuzz test, which is used to n= ame + * the debugfs entry, e.g., /sys/kernel/debug/kfuzztest/@test_name. + * @test_arg_type: The struct type that defines the inputs for the test. T= his + * must be the full struct type (e.g., "struct my_inputs"), not a typedef. + * + * Context: + * This macro is the primary entry point for the KFuzzTest framework. It + * generates all the necessary boilerplate for a fuzz test, including: + * - A static `struct kfuzztest_target` instance that is placed in a + * dedicated ELF section for discovery by userspace tools. + * - A `debugfs` write callback that handles receiving serialized data f= rom + * a fuzzer, parsing it, and "hydrating" it into a valid C struct. + * - A function stub where the developer places the test logic. + * + * User-Provided Logic: + * The developer must provide the body of the fuzz test logic within the c= urly + * braces following the macro invocation. Within this scope, the framework + * provides the following variables: + * + * - `arg`: A pointer of type `@test_arg_type *` to the fully hydrated inp= ut + * structure. All pointer fields within this struct have been relocated + * and are valid kernel pointers. This is the primary variable to use + * for accessing fuzzing inputs. + * + * - `regions`: A pointer of type `struct reloc_region_array *`. This is an + * advanced feature that allows access to the raw region metadata, which + * can be useful for checking the actual allocated size of a buffer via + * `KFUZZTEST_REGION_SIZE(n)`. + * + * Example Usage: + * + * // 1. The kernel function we want to fuzz. + * int process_data(const char *data, size_t len); + * + * // 2. Define a struct to hold all inputs for the function. + * struct process_data_inputs { + * const char *data; + * size_t len; + * }; + * + * // 3. Define the fuzz test using the FUZZ_TEST macro. + * FUZZ_TEST(process_data_fuzzer, struct process_data_inputs) + * { + * int ret; + * // Use KFUZZTEST_EXPECT_* to enforce preconditions. + * // The test will exit early if data is NULL. + * KFUZZTEST_EXPECT_NOT_NULL(process_data_inputs, data); + * + * // Use KFUZZTEST_ANNOTATE_* to provide hints to the fuzzer. + * // This links the 'len' field to the 'data' buffer. + * KFUZZTEST_ANNOTATE_LEN(process_data_inputs, len, data); + * + * // Call the function under test using the 'arg' variable. OOB memory + * // accesses will be caught by KASAN, but the user can also choose to + * // validate the return value and log any failures. + * ret =3D process_data(arg->data, arg->len); + * } + */ +#define FUZZ_TEST(test_name, test_arg_type) = \ + static ssize_t kfuzztest_write_cb_##test_name(struct file *filp, const ch= ar __user *buf, size_t len, \ + loff_t *off); \ + static void kfuzztest_logic_##test_name(test_arg_type *arg); = \ + const struct kfuzztest_target __fuzz_test__##test_name __section(".kfuzzt= est_target") __used =3D { \ + .name =3D #test_name, = \ + .arg_type_name =3D #test_arg_type, = \ + .write_input_cb =3D kfuzztest_write_cb_##test_name, = \ + }; = \ + static ssize_t kfuzztest_write_cb_##test_name(struct file *filp, const ch= ar __user *buf, size_t len, \ + loff_t *off) \ + { = \ + test_arg_type *arg; = \ + void *buffer; = \ + int ret; = \ + = \ + buffer =3D kmalloc(len, GFP_KERNEL); = \ + if (!buffer) = \ + return -ENOMEM; = \ + ret =3D simple_write_to_buffer(buffer, len, off, buf, len); = \ + if (ret < 0) = \ + goto out; = \ + ret =3D kfuzztest_parse_and_relocate(buffer, len, (void **)&arg); = \ + if (ret < 0) = \ + goto out; = \ + kfuzztest_logic_##test_name(arg); = \ + ret =3D len; = \ +out: = \ + kfree(buffer); = \ + return ret; = \ + } = \ + static void kfuzztest_logic_##test_name(test_arg_type *arg) + +enum kfuzztest_constraint_type { + EXPECT_EQ, + EXPECT_NE, + EXPECT_LT, + EXPECT_LE, + EXPECT_GT, + EXPECT_GE, + EXPECT_IN_RANGE, +}; + +/** + * struct kfuzztest_constraint - a metadata record for a domain constraint + * + * Domain constraints are rules about the input data that must be satisfie= d for + * a fuzz test to proceed. While they are enforced in the kernel with a ru= ntime + * check, they are primarily intended as a discoverable contract for users= pace + * fuzzers. + * + * Instances of this struct are generated by the KFUZZTEST_EXPECT_* macros + * and placed into the read-only ".kfuzztest_constraint" ELF section of the + * vmlinux binary. A fuzzer can parse this section to learn about the + * constraints and generate valid inputs more intelligently. + * + * For an example of how these constraints are used within a fuzz test, se= e the + * documentation for the FUZZ_TEST() macro. + * + * @input_type: The name of the input struct type, without the leading + * "struct ". + * @field_name: The name of the field within the struct that this constrai= nt + * applies to. + * @value1: The primary value used in the comparison (e.g., the upper + * bound for EXPECT_LE). + * @value2: The secondary value, used only for multi-value comparisons + * (e.g., the upper bound for EXPECT_IN_RANGE). + * @type: The type of the constraint. + */ +struct kfuzztest_constraint { + const char *input_type; + const char *field_name; + uintptr_t value1; + uintptr_t value2; + enum kfuzztest_constraint_type type; +} __aligned(64); + +#define __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val1, val2, tpe) = \ + static struct kfuzztest_constraint __constraint_##arg_type##_##field __se= ction(".kfuzztest_constraint") \ + __used =3D { = \ + .input_type =3D "struct " #arg_type, = \ + .field_name =3D #field, = \ + .value1 =3D (uintptr_t)val1, = \ + .value2 =3D (uintptr_t)val2, = \ + .type =3D tpe, = \ + } + +/** + * KFUZZTEST_EXPECT_EQ - constrain a field to be equal to a value + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable + * @val: a value of the same type as @arg_type.@field + */ +#define KFUZZTEST_EXPECT_EQ(arg_type, field, val) = \ + do { = \ + if (arg->field !=3D val) \ + return; \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val, 0x0, EXPECT_EQ); \ + } while (0) + +/** + * KFUZZTEST_EXPECT_NE - constrain a field to be not equal to a value + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @val: a value of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_NE(arg_type, field, val) = \ + do { = \ + if (arg->field =3D=3D val) = \ + return; \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val, 0x0, EXPECT_NE); \ + } while (0) + +/** + * KFUZZTEST_EXPECT_LT - constrain a field to be less than a value + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @val: a value of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_LT(arg_type, field, val) = \ + do { = \ + if (arg->field >=3D val) \ + return; \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val, 0x0, EXPECT_LT); \ + } while (0) + +/** + * KFUZZTEST_EXPECT_LE - constrain a field to be less than or equal to a v= alue + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @val: a value of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_LE(arg_type, field, val) = \ + do { = \ + if (arg->field > val) \ + return; \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val, 0x0, EXPECT_LE); \ + } while (0) + +/** + * KFUZZTEST_EXPECT_GT - constrain a field to be greater than a value + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @val: a value of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_GT(arg_type, field, val) = \ + do { = \ + if (arg->field <=3D val) \ + return; \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val, 0x0, EXPECT_GT) \ + } while (0) + +/** + * KFUZZTEST_EXPECT_GE - constrain a field to be greater than or equal to = a value + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @val: a value of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_GE(arg_type, field, val) = \ + do { = \ + if (arg->field < val) \ + return; \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, val, 0x0, EXPECT_GE)` \ + } while (0) + +/** + * KFUZZTEST_EXPECT_GE - constrain a pointer field to be non-NULL + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @val: a value of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_NOT_NULL(arg_type, field) KFUZZTEST_EXPECT_NE(arg= _type, field, NULL) + +/** + * KFUZZTEST_EXPECT_IN_RANGE - constrain a field to be within a range + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: some field that is comparable. + * @lower_bound: a lower bound of the same type as @arg_type.@field. + * @upper_bound: an upper bound of the same type as @arg_type.@field. + */ +#define KFUZZTEST_EXPECT_IN_RANGE(arg_type, field, lower_bound, upper_boun= d) \ + do { = \ + if (arg->field < lower_bound || arg->field > upper_bound) = \ + return; = \ + __KFUZZTEST_DEFINE_CONSTRAINT(arg_type, field, lower_bound, upper_bound,= EXPECT_IN_RANGE) \ + } while (0) + +/** + * Annotations express attributes about structure fields that can't be eas= ily + * or safely verified at runtime. They are intended as hints to the fuzzing + * engine to help it generate more semantically correct and effective inpu= ts. + * Unlike constraints, annotations do not add any runtime checks and do not + * cause a test to exit early. + * + * For example, a `char *` field could be a raw byte buffer or a C-style + * null-terminated string. A fuzzer that is aware of this distinction can = avoid + * creating inputs that would cause trivial, uninteresting crashes from re= ading + * past the end of a non-null-terminated buffer. + */ +enum kfuzztest_annotation_attribute : uint8_t { + ATTRIBUTE_LEN, + ATTRIBUTE_STRING, + ATTRIBUTE_ARRAY, +}; + +/** + * struct kfuzztest_annotation - a metadata record for a fuzzer hint + * + * This struct captures a single hint about a field in the input structure. + * Instances are generated by the KFUZZTEST_ANNOTATE_* macros and are plac= ed + * into the read-only ".kfuzztest_annotation" ELF section of the vmlinux b= inary. + * + * A userspace fuzzer can parse this section to understand the semantic + * relationships between fields (e.g., which field is a length for which + * buffer) and the expected format of the data (e.g., a null-terminated + * string). This allows the fuzzer to be much more intelligent during input + * generation and mutation. + * + * For an example of how annotations are used within a fuzz test, see the + * documentation for the FUZZ_TEST() macro. + * + * @input_type: The name of the input struct type. + * @field_name: The name of the field being annotated (e.g., the data + * buffer field). + * @linked_field_name: For annotations that link two fields (like + * ATTRIBUTE_LEN), this is the name of the related field (e.g., the + * length field). For others, this may be unused. + * @attrib: The type of the annotation hint. + */ +struct kfuzztest_annotation { + const char *input_type; + const char *field_name; + const char *linked_field_name; + enum kfuzztest_annotation_attribute attrib; +} __aligned(32); + +#define __KFUZZTEST_ANNOTATE(arg_type, field, linked_field, attribute) = \ + static struct kfuzztest_annotation __annotation_##arg_type##_##field __se= ction(".kfuzztest_annotation") \ + __used =3D { = \ + .input_type =3D "struct " #arg_type, = \ + .field_name =3D #field, = \ + .linked_field_name =3D #linked_field, = \ + .attrib =3D attribute, = \ + } + +/** + * KFUZZTEST_ANNOTATE_STRING - annotate a char* field as a C string + * + * We define a C string as a sequence of non-zero characters followed by e= xactly + * one null terminator. + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: the name of the field to annotate. + */ +#define KFUZZTEST_ANNOTATE_STRING(arg_type, field) __KFUZZTEST_ANNOTATE(ar= g_type, field, NULL, ATTRIBUTE_STRING) + +/** + * KFUZZTEST_ANNOTATE_ARRAY - annotate a pointer as an array + * + * We define an array as a contiguous memory region containing zero or more + * elements of the same type. + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: the name of the field to annotate. + */ +#define KFUZZTEST_ANNOTATE_ARRAY(arg_type, field) __KFUZZTEST_ANNOTATE(arg= _type, field, NULL, ATTRIBUTE_ARRAY) + +/** + * KFUZZTEST_ANNOTATE_LEN - annotate a field as the length of another + * + * This expresses the relationship `arg_type.field =3D=3D len(linked_field= )`, where + * `linked_field` is an array. + * + * @arg_type: name of the input structure, without the leading "struct ". + * @field: the name of the field to annotate. + * @linked_field: the name of an array field with length @field. + */ +#define KFUZZTEST_ANNOTATE_LEN(arg_type, field, linked_field) \ + __KFUZZTEST_ANNOTATE(arg_type, field, linked_field, ATTRIBUTE_LEN) + +#define KFUZZTEST_REGIONID_NULL U32_MAX + +/** + * The end of the input should be padded by at least this number of bytes = as + * it is poisoned to detect out of bounds accesses at the end of the last + * region. + */ +#define KFUZZTEST_POISON_SIZE 0x8 + +#endif /* KFUZZTEST_H */ diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index ebe33181b6e6..3542e94204c8 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -1947,6 +1947,7 @@ endmenu menu "Kernel Testing and Coverage" =20 source "lib/kunit/Kconfig" +source "lib/kfuzztest/Kconfig" =20 config NOTIFIER_ERROR_INJECTION tristate "Notifier error injection" diff --git a/lib/kfuzztest/Kconfig b/lib/kfuzztest/Kconfig new file mode 100644 index 000000000000..f9fb5abf8d27 --- /dev/null +++ b/lib/kfuzztest/Kconfig @@ -0,0 +1,20 @@ +# SPDX-License-Identifier: GPL-2.0-only + +config KFUZZTEST + bool "KFuzzTest - enable support for internal fuzz targets" + depends on DEBUG_FS && DEBUG_KERNEL + help + Enables support for the kernel fuzz testing framework (KFuzzTest), an + interface for exposing internal kernel functions to a userspace fuzzing + engine. KFuzzTest targets are exposed via a debugfs interface that + accepts serialized userspace inputs, and is designed to make it easier + to fuzz deeply nested kernel code that is hard to reach from the system + call boundary. Using a simple macro-based API, developers can add a new + fuzz target with minimal boilerplate code. + + It is strongly recommended to also enable CONFIG_KASAN for byte-accurate + out-of-bounds detection, as KFuzzTest was designed with this in mind. It + is also recommended to enable CONFIG_KCOV for coverage guided fuzzing. + + WARNING: This exposes internal kernel functions directly to userspace + and must NEVER be enabled in production builds. --=20 2.51.0.318.gd7df087d1a-goog From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wm1-f45.google.com (mail-wm1-f45.google.com [209.85.128.45]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CCD183064B4; Mon, 1 Sep 2025 16:43:12 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.45 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744995; cv=none; b=jSQ4ys3VgdUuGrGgT4yKPz92Rt7Ij47UKeLmO1HGbEmVMBr8V4DqYY3th//liVqbsdssJyuY1KUBD/PEUhSWdaaML+EIYG2oIqAGpmVHfeShMzCqo17sQ9kLW77cWJzQdvEyDM5BoUElPWoeIUEKUHVlIdzug9DHXR9h0i8eAzI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744995; c=relaxed/simple; bh=S6N01nBYbCXD8XZ4yb//ZVhJP9zZQRGNuxTMKWxUH+A=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=SCgNkjV7gX3xaQmvxhOqGhAQm1H69pQXgrjiJokp6Lob3ozGSmjW5YioOwYcy3Lr6hn4p3nTw+8hXPDdPJf0pBkC8Y84R6+zn1FUyyfk+0B1icyHJH+wMB+mpRf5T1chtylFzuYITbjFD3xEyJm+hljHvnswX8icoIALeAKv60s= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=G0iXAj0b; arc=none smtp.client-ip=209.85.128.45 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="G0iXAj0b" Received: by mail-wm1-f45.google.com with SMTP id 5b1f17b1804b1-45a1b065d59so31283185e9.1; Mon, 01 Sep 2025 09:43:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744991; x=1757349791; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=JMtkoie1PzFbZ/9GVFEn9qZYkcpNtvbFVewJfLAvroI=; b=G0iXAj0bx1ylXV8YxCz4VFr8JmHcik0DQAoodnvlq+TwRbXz9OJrj3vamMMPAXRxMJ 5lQ8gW9yBR98tzPrU64z4xif9SVNVdZxsx5VfjqJh7EjE5iCWgzrOp6iF4GCwtZE3lRM d/7LT8/P/k2Uk6i6eX+53IZMO4DwVkSzjslc3pXIR4lkwCsLex0CCByWV8Yb7mpuUYxh x1/9stIfWua2WTw40ZW6ce7qImOi5uIVVy+7Vij9YPrLC98p3UUhHZDuo3kTnjU8mLnK 3LWv3Bgxo5Q04SXJuqdbDz5tyQe3TkeuBFgouGU2qcRz4rFIqW/uPtQfck2JF3p+xbj7 ImaQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744991; x=1757349791; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=JMtkoie1PzFbZ/9GVFEn9qZYkcpNtvbFVewJfLAvroI=; b=S2v79n5duCbqjOyP+Lhfyz9x9MC+/6s1WzMB/BUwkWj0ZXYEQCH7eJq73LhencGTvj mpMGTHbmgBmTJ+0YMVRgCN3ZBAwkPwDOC7CT2eXd2/lmVSfckvD7Vf5D+s2BlO9Spvmt CU4grvSTOWI7qyHiHYqIRkDGah8uCTwj2cFV7rWqPTpoWpHi6sfM6kaS4bo+18veIjV5 hy+7F3EzGmbprYa43+M43kLrLfbnCL4RZUE2fJjOdSInafB92dD6cO0hUMqR7C3fSpqo TX/dJCe8oPJiUsBNxkmde0377H12rzOakDfC7RRE6nsfCadgC9sou6liCa0IBEf9RFxB MofQ== X-Forwarded-Encrypted: i=1; AJvYcCWxtrJ1f66NzmBacQEQF+OcCz6AkPNZgK8H6abnmlX3QX8nD5pr++xXrvu3wfhZXNidtp5MTXDKxwOoS8yd@vger.kernel.org, AJvYcCXttB53p5r7QyIpLB/gGHklICJHj+hAhQ7Odd8wKQWPiVgVtTYAvIqxtgXa7yFeZoPYJgbHBQVCpn/YmgY=@vger.kernel.org X-Gm-Message-State: AOJu0YwCryth73EiiAXxYsqq7X9KMCDRtHd/BTkoDCP5SXgiGRMsM5AS /hM/B7NHqOu4a3p8Ef3xjXRZy3VxNCDp0YIyN9IjZkzA17XgwACt4AAhnI2EaUFrNmF5Ag== X-Gm-Gg: ASbGnctNCvokWo66w8VXPTUZp3OINPkv0Z+cW6tzXohp3qvQPg/0XWhqY0Qb/pfCpmd AoHX6KIEjWTsOOq+yRS7RgW0JNTBVs/vjpgIqdjNWc3kTlqMkY0jU3FlJHZpmaJOC5rANDqbTyY caPgTB3sn7B7sKLz+LwAM8OJH1tQ/6xSpnVSbxZ5sB/A/JEg17KgPAuIJAVliNQSc8bBiJgeA0R BKZpY7lbdNPNQDJiOiKMGuL1alVCA8Ga06T3C7tbkqRkVPGOV9A+4+UjrNDz8D0qDhcInzZve8J Pv00Hajt8NPEgdRR6MQhIs0KFD2JYAEAiMHts+Ev842x5Vn3V6t+Y976aEYTjvSQqSPmVX7RcoE X8qRcbvakJzr0I/oStKpPlgOaDM+emJ2XWuSHuuVx6PlMYhL7BcBS2oF/zDVV493IW5c5+bug69 a3ycQfmN+N6Lqk7rQ8nA== X-Google-Smtp-Source: AGHT+IGpM9bd6W7FkfsOwYPD+t+MlaqBnshvtZm283Cr6UHrucbgXHfgvmEeeRzAnIY+IYjLZ+c+6A== X-Received: by 2002:a05:600c:3b8a:b0:45b:8935:16bc with SMTP id 5b1f17b1804b1-45b8ee1788emr25495035e9.37.1756744990976; Mon, 01 Sep 2025 09:43:10 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:10 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 3/7] kfuzztest: implement core module and input processing Date: Mon, 1 Sep 2025 16:42:08 +0000 Message-ID: <20250901164212.460229-4-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Add the core runtime implementation for KFuzzTest. This includes the module initialization, and the logic for receiving and processing user-provided inputs through debugfs. On module load, the framework discovers all test targets by iterating over the .kfuzztest_target section, creating a corresponding debugfs directory with a write-only 'input' file for each of them. Writing to an 'input' file triggers the main fuzzing sequence: 1. The serialized input is copied from userspace into a kernel buffer. 2. The buffer is parsed to validate the region array and relocation table. 3. Pointers are patched based on the relocation entries, and in KASAN builds the inter-region padding is poisoned. 4. The resulting struct is passed to the user-defined test logic. Signed-off-by: Ethan Graham --- v2: - The module's init function now taints the kernel with TAINT_TEST. --- --- lib/Makefile | 2 + lib/kfuzztest/Makefile | 4 + lib/kfuzztest/main.c | 163 ++++++++++++++++++++++++++++++++ lib/kfuzztest/parse.c | 208 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 377 insertions(+) create mode 100644 lib/kfuzztest/Makefile create mode 100644 lib/kfuzztest/main.c create mode 100644 lib/kfuzztest/parse.c diff --git a/lib/Makefile b/lib/Makefile index c38582f187dd..511c44ef4b19 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -354,6 +354,8 @@ obj-$(CONFIG_GENERIC_LIB_CMPDI2) +=3D cmpdi2.o obj-$(CONFIG_GENERIC_LIB_UCMPDI2) +=3D ucmpdi2.o obj-$(CONFIG_OBJAGG) +=3D objagg.o =20 +obj-$(CONFIG_KFUZZTEST) +=3D kfuzztest/ + # pldmfw library obj-$(CONFIG_PLDMFW) +=3D pldmfw/ =20 diff --git a/lib/kfuzztest/Makefile b/lib/kfuzztest/Makefile new file mode 100644 index 000000000000..142d16007eea --- /dev/null +++ b/lib/kfuzztest/Makefile @@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_KFUZZTEST) +=3D kfuzztest.o +kfuzztest-objs :=3D main.o parse.o diff --git a/lib/kfuzztest/main.c b/lib/kfuzztest/main.c new file mode 100644 index 000000000000..c24350eb1fca --- /dev/null +++ b/lib/kfuzztest/main.c @@ -0,0 +1,163 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * KFuzzTest core module initialization and debugfs interface. + * + * Copyright 2025 Google LLC + */ +#include +#include +#include +#include +#include + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Ethan Graham "); +MODULE_DESCRIPTION("Kernel Fuzz Testing Framework (KFuzzTest)"); + +extern const struct kfuzztest_target __kfuzztest_targets_start[]; +extern const struct kfuzztest_target __kfuzztest_targets_end[]; + +/** + * struct kfuzztest_dentry - A container for a debugfs dentry and its fops. + * @dentry: Pointer to the created debugfs dentry. + * @fops: The file_operations struct associated with this dentry. + * + * This simplifies state management by keeping a file's dentry and its + * operations bundled together. + */ +struct kfuzztest_dentry { + struct dentry *dentry; + struct file_operations fops; +}; + +/** + * struct kfuzztest_debugfs_state - Per-test-case debugfs state. + * @test_dir: The top-level debugfs directory for a single test case, e.g., + * /sys/kernel/debug/kfuzztest//. + * @input_dentry: The state for the "input" file, which is write-only. + * + * Wraps all debugfs components created for a single test case. + */ +struct kfuzztest_debugfs_state { + struct dentry *target_dir; + struct kfuzztest_dentry input_dentry; +}; + +/** + * struct kfuzztest_simple_fuzzer_state - Global state for the KFTF module. + * @kfuzztest_dir: The root debugfs directory, /sys/kernel/debug/kfuzztest= /. + * @debugfs_state: A statically sized array holding the state for each + * registered test case. + */ +struct kfuzztest_state { + struct file_operations fops; + struct dentry *kfuzztest_dir; + struct kfuzztest_debugfs_state *debugfs_state; +}; + +/* Global static variable to hold all state for the module. */ +static struct kfuzztest_state state; + +const umode_t KFUZZTEST_INPUT_PERMS =3D 0222; + +/** + * kfuzztest_init - Initializes the debug filesystem for KFuzzTest. + * + * Each registered test in the ".kfuzztest" section gets its own subdirect= ory + * under "/sys/kernel/debug/kfuzztest/" with one files: + * - input: write-only file to send input to the fuzz driver + * + * Returns: + * 0 on success. + * -ENODEV or other error codes if debugfs creation fails. + */ +static int __init kfuzztest_init(void) +{ + const struct kfuzztest_target *targ; + int ret =3D 0; + int i =3D 0; + size_t num_test_cases; + + num_test_cases =3D __kfuzztest_targets_end - __kfuzztest_targets_start; + + state.debugfs_state =3D + kzalloc(num_test_cases * sizeof(struct kfuzztest_debugfs_state), + GFP_KERNEL); + if (!state.debugfs_state) + return -ENOMEM; + + /* Create the main "kfuzztest" directory in /sys/kernel/debug. */ + state.kfuzztest_dir =3D debugfs_create_dir("kfuzztest", NULL); + if (!state.kfuzztest_dir) { + pr_warn("KFuzzTest: could not create debugfs"); + return -ENODEV; + } + + if (IS_ERR(state.kfuzztest_dir)) { + state.kfuzztest_dir =3D NULL; + return PTR_ERR(state.kfuzztest_dir); + } + + for (targ =3D __kfuzztest_targets_start; targ < __kfuzztest_targets_end; + targ++, i++) { + /* Create debugfs directory for the target. */ + state.debugfs_state[i].target_dir =3D + debugfs_create_dir(targ->name, state.kfuzztest_dir); + + if (!state.debugfs_state[i].target_dir) { + ret =3D -ENOMEM; + goto cleanup_failure; + } else if (IS_ERR(state.debugfs_state[i].target_dir)) { + ret =3D PTR_ERR(state.debugfs_state[i].target_dir); + goto cleanup_failure; + } + + /* Create an input file under the target's directory. */ + state.debugfs_state[i].input_dentry.fops =3D + (struct file_operations){ + .owner =3D THIS_MODULE, + .write =3D targ->write_input_cb, + }; + state.debugfs_state[i].input_dentry.dentry =3D + debugfs_create_file( + "input", KFUZZTEST_INPUT_PERMS, + state.debugfs_state[i].target_dir, NULL, + &state.debugfs_state[i].input_dentry.fops); + if (!state.debugfs_state[i].input_dentry.dentry) { + ret =3D -ENOMEM; + goto cleanup_failure; + } else if (IS_ERR(state.debugfs_state[i].input_dentry.dentry)) { + ret =3D PTR_ERR( + state.debugfs_state[i].input_dentry.dentry); + goto cleanup_failure; + } + + pr_info("KFuzzTest: registered target %s", targ->name); + } + + /* Taint the kernel after successfully creating the debugfs entries. */ + add_taint(TAINT_TEST, LOCKDEP_STILL_OK); + return 0; + +cleanup_failure: + debugfs_remove_recursive(state.kfuzztest_dir); + return ret; +} + +static void __exit kfuzztest_exit(void) +{ + pr_info("KFuzzTest: exiting"); + if (!state.kfuzztest_dir) + return; + + debugfs_remove_recursive(state.kfuzztest_dir); + state.kfuzztest_dir =3D NULL; + + if (state.debugfs_state) { + kfree(state.debugfs_state); + state.debugfs_state =3D NULL; + } +} + +module_init(kfuzztest_init); +module_exit(kfuzztest_exit); diff --git a/lib/kfuzztest/parse.c b/lib/kfuzztest/parse.c new file mode 100644 index 000000000000..6010171190ad --- /dev/null +++ b/lib/kfuzztest/parse.c @@ -0,0 +1,208 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * KFuzzTest input parsing and validation. + * + * Copyright 2025 Google LLC + */ +#include +#include + +/* + * Enforce a fixed struct size to ensure a consistent stride when iteratin= g over + * the array of these structs in the dedicated ELF section. + */ +static_assert(sizeof(struct kfuzztest_target) =3D=3D 32, "struct kfuzztest= _target should have size 32"); +static_assert(sizeof(struct kfuzztest_constraint) =3D=3D 64, "struct kfuzz= test_constraint should have size 64"); +static_assert(sizeof(struct kfuzztest_annotation) =3D=3D 32, "struct kfuzz= test_annotation should have size 32"); + +static int kfuzztest_relocate_v0(struct reloc_region_array *regions, struc= t reloc_table *rt, void *payload_start, + void *payload_end) +{ + struct reloc_region reg, src, dst; + void *poison_start, *poison_end; + uintptr_t *ptr_location; + struct reloc_entry re; + size_t i; + + /* Patch pointers. */ + for (i =3D 0; i < rt->num_entries; i++) { + re =3D rt->entries[i]; + src =3D regions->regions[re.region_id]; + ptr_location =3D (uintptr_t *)((char *)payload_start + src.offset + re.r= egion_offset); + if (re.value =3D=3D KFUZZTEST_REGIONID_NULL) + *ptr_location =3D (uintptr_t)NULL; + else if (re.value < regions->num_regions) { + dst =3D regions->regions[re.value]; + *ptr_location =3D (uintptr_t)((char *)payload_start + dst.offset); + } else + return -EINVAL; + } + + /* Poison the padding between regions. */ + for (i =3D 0; i < regions->num_regions; i++) { + reg =3D regions->regions[i]; + + /* Points to the beginning of the inter-region padding */ + poison_start =3D payload_start + reg.offset + reg.size; + if (i < regions->num_regions - 1) + poison_end =3D payload_start + regions->regions[i + 1].offset; + else + poison_end =3D payload_end; + + if ((char *)poison_end > (char *)payload_end) + return -EINVAL; + + kasan_poison_range(poison_start, poison_end - poison_start); + } + + /* Poison the padded area preceding the payload. */ + kasan_poison_range((char *)payload_start - rt->padding_size, rt->padding_= size); + return 0; +} + +static bool kfuzztest_input_is_valid(struct reloc_region_array *regions, s= truct reloc_table *rt, void *payload_start, + void *payload_end) +{ + size_t payload_size =3D (char *)payload_end - (char *)payload_start; + struct reloc_region reg, next_reg; + size_t usable_payload_size; + uint32_t region_end_offset; + struct reloc_entry reloc; + uint32_t i; + + if ((char *)payload_start > (char *)payload_end) + return false; + if (payload_size < KFUZZTEST_POISON_SIZE) + return false; + usable_payload_size =3D payload_size - KFUZZTEST_POISON_SIZE; + + for (i =3D 0; i < regions->num_regions; i++) { + reg =3D regions->regions[i]; + if (check_add_overflow(reg.offset, reg.size, ®ion_end_offset)) + return false; + if ((size_t)region_end_offset > usable_payload_size) + return false; + + if (i < regions->num_regions - 1) { + next_reg =3D regions->regions[i + 1]; + if (reg.offset > next_reg.offset) + return false; + /* + * Enforce the minimum poisonable gap between + * consecutive regions. + */ + if (reg.offset + reg.size + KFUZZTEST_POISON_SIZE > next_reg.offset) + return false; + } + } + + if (rt->padding_size < KFUZZTEST_POISON_SIZE) { + pr_info("validation failed because rt->padding_size =3D %u", rt->padding= _size); + return false; + } + + for (i =3D 0; i < rt->num_entries; i++) { + reloc =3D rt->entries[i]; + if (reloc.region_id >=3D regions->num_regions) + return false; + if (reloc.value !=3D KFUZZTEST_REGIONID_NULL && reloc.value >=3D regions= ->num_regions) + return false; + + reg =3D regions->regions[reloc.region_id]; + if (reloc.region_offset % (sizeof(uintptr_t)) || reloc.region_offset + s= izeof(uintptr_t) > reg.size) + return false; + } + + return true; +} + +static int kfuzztest_parse_input_v0(void *input, size_t input_size, struct= reloc_region_array **ret_regions, + struct reloc_table **ret_reloc_table, void **ret_payload_start, + void **ret_payload_end) +{ + size_t reloc_entries_size, reloc_regions_size; + size_t reloc_table_size, regions_size; + struct reloc_region_array *regions; + void *payload_end, *payload_start; + struct reloc_table *rt; + size_t curr_offset =3D 0; + + if (input_size < sizeof(struct reloc_region_array) + sizeof(struct reloc_= table)) + return -EINVAL; + + regions =3D input; + if (check_mul_overflow(regions->num_regions, sizeof(struct reloc_region),= &reloc_regions_size)) + return -EINVAL; + if (check_add_overflow(sizeof(*regions), reloc_regions_size, ®ions_siz= e)) + return -EINVAL; + + curr_offset =3D regions_size; + if (curr_offset > input_size) + return -EINVAL; + if (input_size - curr_offset < sizeof(struct reloc_table)) + return -EINVAL; + + rt =3D (struct reloc_table *)((char *)input + curr_offset); + + if (check_mul_overflow((size_t)rt->num_entries, sizeof(struct reloc_entry= ), &reloc_entries_size)) + return -EINVAL; + if (check_add_overflow(sizeof(*rt), reloc_entries_size, &reloc_table_size= )) + return -EINVAL; + if (check_add_overflow(reloc_table_size, rt->padding_size, &reloc_table_s= ize)) + return -EINVAL; + + if (check_add_overflow(curr_offset, reloc_table_size, &curr_offset)) + return -EINVAL; + if (curr_offset > input_size) + return -EINVAL; + + payload_start =3D (char *)input + curr_offset; + payload_end =3D (char *)input + input_size; + + if (!kfuzztest_input_is_valid(regions, rt, payload_start, payload_end)) + return -EINVAL; + + *ret_regions =3D regions; + *ret_reloc_table =3D rt; + *ret_payload_start =3D payload_start; + *ret_payload_end =3D payload_end; + return 0; +} + +static int kfuzztest_parse_and_relocate_v0(void *input, size_t input_size,= void **arg_ret) +{ + struct reloc_region_array *regions; + void *payload_start, *payload_end; + struct reloc_table *reloc_table; + int ret; + + ret =3D kfuzztest_parse_input_v0(input, input_size, ®ions, &reloc_tabl= e, &payload_start, &payload_end); + if (ret < 0) + return ret; + + ret =3D kfuzztest_relocate_v0(regions, reloc_table, payload_start, payloa= d_end); + if (ret < 0) + return ret; + *arg_ret =3D payload_start; + return 0; +} + +int kfuzztest_parse_and_relocate(void *input, size_t input_size, void **ar= g_ret) +{ + u32 version, magic; + + if (input_size < sizeof(u32) + sizeof(u32)) + return -EINVAL; + + magic =3D *(u32 *)input; + if (magic !=3D KFUZZTEST_HEADER_MAGIC) + return -EINVAL; + + version =3D *(u32 *)((char *)input + sizeof(u32)); + switch (version) { + case KFUZZTEST_V0: + return kfuzztest_parse_and_relocate_v0(input + sizeof(u64), input_size -= sizeof(u64), arg_ret); + } + + return -EINVAL; +} --=20 2.51.0.318.gd7df087d1a-goog From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wr1-f50.google.com (mail-wr1-f50.google.com [209.85.221.50]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 347EE3101B6; Mon, 1 Sep 2025 16:43:13 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.50 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744997; cv=none; b=mqa+Cu+kBaZbkz9KZkQSRqSp+lizxA5WhysTxeCPofb1hZCPYvqc8Ol0sgB8c9AJ7P8YN/DQrx9R9W5EmBWVw6veXcBHzewCXjq2iqrcwOGFOIC2IBKwXdYrAK+ypgOuoZstGkiIJiG/HWt9BYJILBsIJje0Hx+z8PQT1zkM5Wo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744997; c=relaxed/simple; bh=h76A9u6zkuE/20Bo7Xdcsm2OmK9RA2JmpbWJMmQNPoA=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ckO/hSBhW0DMvkAHt7mmnigT1YVV1gq5vQfR0m3CH36TFh9D78v0PL1v7t3BoT66bv7/ueGQidXjR9eU/Nza+YrMoj1QJS6mcl/lCU77NWxnQMPMWtj8/EaKGFFxpw0Jj7rI9XuK7C7hA6uOZnj4B7EEHGgDiFxE48e1JLTKOOw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=DeWlBdG7; arc=none smtp.client-ip=209.85.221.50 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="DeWlBdG7" Received: by mail-wr1-f50.google.com with SMTP id ffacd0b85a97d-3d17f24d42fso1803211f8f.1; Mon, 01 Sep 2025 09:43:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744992; x=1757349792; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=A8/Bc+EJuXaIVuuL4/eLKggLF3t+Hgxg98LF9wr4aQ0=; b=DeWlBdG7fGSOPESH0pYgqce9tM5gMNfLFyN47IPfypS21aPpNPo0dzLspCvhVWJz2q 789Xvk4gNWF69+/BbmjUn18TkUUtIzYeyJWauQVUdg9eTw41FKQBklzxlLJH8BZayCbX /ZsQeGMsXmPtLOulFgMAOCPbEGo1Fb11KC5RFfSLlswc88XFmnFAZI2J8VFt1eeOhuNM U5LyAAp/OGXaFHL2saMi8TTxVMYDvX4mYNjwn8qky2MseCIkxbAA+RI2zUqdVqYDLjVW ELvLoMueBnEXLQ8ZeKRR6JNZFI3ZONk5VA9Jg3Yne8AOKDkjptfJKQ7ZDXRQj0wCoNJH vRRg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744992; x=1757349792; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=A8/Bc+EJuXaIVuuL4/eLKggLF3t+Hgxg98LF9wr4aQ0=; b=BE9AT2W+GakHR5TEHyLT6OAGVv1gD3GSCizMv5dMAVDyv0JDHfsEIP2KPBnoKWTMHy t+5KYzjb0dwd0aCKzKIOgV6JcR5cp4h/1LRw2JaEIE6xL3RkU01Dz1niGShMKtz+uMtS q9VflJOVlU6oZQ0/4EktrSq8D/+Dye81sM6KgLN833vkX7z4huWR6smbfu8Zax66S8g2 P2X0tDDPfetNswvp6Ce+d2pyWNkVMB4eJsf0hD2uKklbralEaqM2UjVzhANhf2t4/8Mv ecctON9bGzFFOjtylZ5wuJrShiFjO7Ts2xOVg1kHy4jSV+G64oP1JS2YxbLjVmE5llal E7WA== X-Forwarded-Encrypted: i=1; AJvYcCWIZiwMlPtqvg+OJJZZozf9V5CsB2A22TEIDkOR1nJLWXw5F7Jk8dQ8JfJ9Nz4/qkWBsVBKMU0xdJBp+DuB@vger.kernel.org, AJvYcCXjBQi7ArLLfrwgPCLbI81HSNDi30Zwu85OjtTjiEPDc77zQ0LbJlOEixAMD792CUaSpIkDKXpMLEQZcfo=@vger.kernel.org X-Gm-Message-State: AOJu0YxKB8W9u9Z7kT5+9OshlpfqGBbeiT1o+FlzO9VmEreBmBdLi3B3 RoT9hu86E/gIlgSVWy7H/JBrlTmiP5YhHJ3WRVRfRMhkpjKiEn934NUz X-Gm-Gg: ASbGncsXAqO51JJdmOPDVQfevgcK6ZTYgG+A850Pqm7H9XN7p4K61PztdBcncuEA7mo EUOA7gJdCOvOHA8/NE/3EILQeVOWsiYPGx1p+jkQj7jzNmpxJ0/xtP/A4ZTutluvY4OfzqQw/zQ 8w4sqkaUHyPOcBmCVzBtEdb+w4MFFJk792KuvMA2jGTEN7EuKoxAit+j3mSxdjpmpWNTNpBENHL wq5bppZS7gMOW2JiFFSoJ4C98njM3qtKspXlsNr5SqT5R+gsjm8l/06kILwy+1B5LaGoKiMpFKm gphU56/Gj9fOmAWImEZZMgS/HlONgp5k+GePt7xZZvFzXyZY4aB5P77sYGxTggxrGUp4SBAWUTy Gh4gO7egjf6XvUz0Y/6fhXy1fJD1q+bWe4oPKLYPGSdEUvlJMkydMY6hHZTHDbEdR6fepRV6lVm zyrbkzuB1qnj6C+6NfFA== X-Google-Smtp-Source: AGHT+IFP0X6tew9l9y1KzXfzTC2RfA9F/fpj4mTFdJRiKw7k/c49N6/IJD7XpNkjFtTO8zgpKc/IQg== X-Received: by 2002:a05:6000:4013:b0:3b7:94a2:87e8 with SMTP id ffacd0b85a97d-3d1dcb75006mr6697702f8f.18.1756744992033; Mon, 01 Sep 2025 09:43:12 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:11 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 4/7] tools: add kfuzztest-bridge utility Date: Mon, 1 Sep 2025 16:42:09 +0000 Message-ID: <20250901164212.460229-5-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Introduce the kfuzztest-bridge tool, a userspace utility for sending structured inputs to KFuzzTest harnesses via debugfs. The bridge takes a textual description of the expected input format, a file containing random bytes, and the name of the target fuzz test. It parses the description, encodes the random data into the binary format expected by the kernel, and writes the result to the corresponding debugfs entry. This allows for both simple manual testing and integration with userspace fuzzing engines. For example, it can be used for smoke testing by providing data from /dev/urandom, or act as a bridge for blob-based fuzzers (e.g., AFL) to target KFuzzTest harnesses. Signed-off-by: Ethan Graham --- tools/Makefile | 15 +- tools/kfuzztest-bridge/.gitignore | 2 + tools/kfuzztest-bridge/Build | 6 + tools/kfuzztest-bridge/Makefile | 48 ++++ tools/kfuzztest-bridge/bridge.c | 93 +++++++ tools/kfuzztest-bridge/byte_buffer.c | 87 ++++++ tools/kfuzztest-bridge/byte_buffer.h | 31 +++ tools/kfuzztest-bridge/encoder.c | 356 ++++++++++++++++++++++++ tools/kfuzztest-bridge/encoder.h | 16 ++ tools/kfuzztest-bridge/input_lexer.c | 243 +++++++++++++++++ tools/kfuzztest-bridge/input_lexer.h | 57 ++++ tools/kfuzztest-bridge/input_parser.c | 373 ++++++++++++++++++++++++++ tools/kfuzztest-bridge/input_parser.h | 79 ++++++ tools/kfuzztest-bridge/rand_stream.c | 61 +++++ tools/kfuzztest-bridge/rand_stream.h | 46 ++++ 15 files changed, 1507 insertions(+), 6 deletions(-) create mode 100644 tools/kfuzztest-bridge/.gitignore create mode 100644 tools/kfuzztest-bridge/Build create mode 100644 tools/kfuzztest-bridge/Makefile create mode 100644 tools/kfuzztest-bridge/bridge.c create mode 100644 tools/kfuzztest-bridge/byte_buffer.c create mode 100644 tools/kfuzztest-bridge/byte_buffer.h create mode 100644 tools/kfuzztest-bridge/encoder.c create mode 100644 tools/kfuzztest-bridge/encoder.h create mode 100644 tools/kfuzztest-bridge/input_lexer.c create mode 100644 tools/kfuzztest-bridge/input_lexer.h create mode 100644 tools/kfuzztest-bridge/input_parser.c create mode 100644 tools/kfuzztest-bridge/input_parser.h create mode 100644 tools/kfuzztest-bridge/rand_stream.c create mode 100644 tools/kfuzztest-bridge/rand_stream.h diff --git a/tools/Makefile b/tools/Makefile index c31cbbd12c45..7f1dfe022045 100644 --- a/tools/Makefile +++ b/tools/Makefile @@ -21,6 +21,7 @@ help: @echo ' hv - tools used when in Hyper-V clients' @echo ' iio - IIO tools' @echo ' intel-speed-select - Intel Speed Select tool' + @echo ' kfuzztest-bridge - KFuzzTest userspace utility' @echo ' kvm_stat - top-like utility for displaying kvm sta= tistics' @echo ' leds - LEDs tools' @echo ' nolibc - nolibc headers testing and installation' @@ -69,7 +70,7 @@ acpi: FORCE cpupower: FORCE $(call descend,power/$@) =20 -counter firewire hv guest bootconfig spi usb virtio mm bpf iio gpio objtoo= l leds wmi firmware debugging tracing: FORCE +counter firewire hv guest bootconfig spi usb virtio mm bpf iio gpio objtoo= l leds wmi firmware debugging tracing kfuzztest-bridge: FORCE $(call descend,$@) =20 bpf/%: FORCE @@ -126,7 +127,8 @@ all: acpi counter cpupower gpio hv firewire \ perf selftests bootconfig spi turbostat usb \ virtio mm bpf x86_energy_perf_policy \ tmon freefall iio objtool kvm_stat wmi \ - debugging tracing thermal thermometer thermal-engine ynl + debugging tracing thermal thermometer thermal-engine ynl \ + kfuzztest-bridge =20 acpi_install: $(call descend,power/$(@:_install=3D),install) @@ -134,7 +136,7 @@ acpi_install: cpupower_install: $(call descend,power/$(@:_install=3D),install) =20 -counter_install firewire_install gpio_install hv_install iio_install perf_= install bootconfig_install spi_install usb_install virtio_install mm_instal= l bpf_install objtool_install wmi_install debugging_install tracing_install: +counter_install firewire_install gpio_install hv_install iio_install perf_= install bootconfig_install spi_install usb_install virtio_install mm_instal= l bpf_install objtool_install wmi_install debugging_install tracing_install= kfuzztest-bridge_install: $(call descend,$(@:_install=3D),install) =20 selftests_install: @@ -170,7 +172,8 @@ install: acpi_install counter_install cpupower_install = gpio_install \ virtio_install mm_install bpf_install x86_energy_perf_policy_install \ tmon_install freefall_install objtool_install kvm_stat_install \ wmi_install debugging_install intel-speed-select_install \ - tracing_install thermometer_install thermal-engine_install ynl_install + tracing_install thermometer_install thermal-engine_install ynl_install \ + kfuzztest-bridge_install =20 acpi_clean: $(call descend,power/acpi,clean) @@ -178,7 +181,7 @@ acpi_clean: cpupower_clean: $(call descend,power/cpupower,clean) =20 -counter_clean hv_clean firewire_clean bootconfig_clean spi_clean usb_clean= virtio_clean mm_clean wmi_clean bpf_clean iio_clean gpio_clean objtool_cle= an leds_clean firmware_clean debugging_clean tracing_clean: +counter_clean hv_clean firewire_clean bootconfig_clean spi_clean usb_clean= virtio_clean mm_clean wmi_clean bpf_clean iio_clean gpio_clean objtool_cle= an leds_clean firmware_clean debugging_clean tracing_clean kfuzztest-bridge= _clean: $(call descend,$(@:_clean=3D),clean) =20 libapi_clean: @@ -230,6 +233,6 @@ clean: acpi_clean counter_clean cpupower_clean hv_clean= firewire_clean \ freefall_clean build_clean libbpf_clean libsubcmd_clean \ gpio_clean objtool_clean leds_clean wmi_clean firmware_clean debugging_c= lean \ intel-speed-select_clean tracing_clean thermal_clean thermometer_clean t= hermal-engine_clean \ - sched_ext_clean ynl_clean + sched_ext_clean ynl_clean kfuzztest-bridge_clean =20 .PHONY: FORCE diff --git a/tools/kfuzztest-bridge/.gitignore b/tools/kfuzztest-bridge/.gi= tignore new file mode 100644 index 000000000000..4aa9fb0d44e2 --- /dev/null +++ b/tools/kfuzztest-bridge/.gitignore @@ -0,0 +1,2 @@ +# SPDX-License-Identifier: GPL-2.0-only +kfuzztest-bridge diff --git a/tools/kfuzztest-bridge/Build b/tools/kfuzztest-bridge/Build new file mode 100644 index 000000000000..d07341a226d6 --- /dev/null +++ b/tools/kfuzztest-bridge/Build @@ -0,0 +1,6 @@ +kfuzztest-bridge-y +=3D bridge.o +kfuzztest-bridge-y +=3D byte_buffer.o +kfuzztest-bridge-y +=3D encoder.o +kfuzztest-bridge-y +=3D input_lexer.o +kfuzztest-bridge-y +=3D input_parser.o +kfuzztest-bridge-y +=3D rand_stream.o diff --git a/tools/kfuzztest-bridge/Makefile b/tools/kfuzztest-bridge/Makef= ile new file mode 100644 index 000000000000..3a4437fb0d3f --- /dev/null +++ b/tools/kfuzztest-bridge/Makefile @@ -0,0 +1,48 @@ +# SPDX-License-Identifier: GPL-2.0 +# Makefile for KFuzzTest-Bridge +include ../scripts/Makefile.include + +bindir ?=3D /usr/bin + +ifeq ($(srctree),) +srctree :=3D $(patsubst %/,%,$(dir $(CURDIR))) +srctree :=3D $(patsubst %/,%,$(dir $(srctree))) +endif + +MAKEFLAGS +=3D -r + +override CFLAGS +=3D -O2 -g +override CFLAGS +=3D -Wall -Wextra +override CFLAGS +=3D -D_GNU_SOURCE +override CFLAGS +=3D -I$(OUTPUT)include -I$(srctree)/tools/include + +ALL_TARGETS :=3D kfuzztest-bridge +ALL_PROGRAMS :=3D $(patsubst %,$(OUTPUT)%,$(ALL_TARGETS)) + +KFUZZTEST_BRIDGE_IN :=3D $(OUTPUT)kfuzztest-bridge-in.o +KFUZZTEST_BRIDGE :=3D $(OUTPUT)kfuzztest-bridge + +all: $(ALL_PROGRAMS) + +export srctree OUTPUT CC LD CFLAGS +include $(srctree)/tools/build/Makefile.include + +$(KFUZZTEST_BRIDGE_IN): FORCE + $(Q)$(MAKE) $(build)=3Dkfuzztest-bridge + +$(KFUZZTEST_BRIDGE): $(KFUZZTEST_BRIDGE_IN) + $(QUIET_LINK)$(CC) $(CFLAGS) $< -o $@ $(LDFLAGS) + +clean: + rm -f $(ALL_PROGRAMS) + find $(or $(OUTPUT),.) -name '*.o' -delete -o -name '\.*.d' -delete -o -n= ame '\.*.o.cmd' -delete + +install: $(ALL_PROGRAMS) + install -d -m 755 $(DESTDIR)$(bindir); \ + for program in $(ALL_PROGRAMS); do \ + install $$program $(DESTDIR)$(bindir); \ + done + +FORCE: + +.PHONY: all install clean FORCE prepare diff --git a/tools/kfuzztest-bridge/bridge.c b/tools/kfuzztest-bridge/bridg= e.c new file mode 100644 index 000000000000..3815cb8fd6e7 --- /dev/null +++ b/tools/kfuzztest-bridge/bridge.c @@ -0,0 +1,93 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * KFuzzTest tool for sending inputs into a KFuzzTest harness + * + * Copyright 2025 Google LLC + */ + +#include +#include +#include +#include +#include + +#include "byte_buffer.h" +#include "encoder.h" +#include "input_lexer.h" +#include "input_parser.h" +#include "rand_stream.h" + +static int invoke_kfuzztest_target(const char *target_name, const char *da= ta, size_t data_size) +{ + ssize_t bytes_written; + char buf[256]; + int ret; + int fd; + + ret =3D snprintf(buf, sizeof(buf), "/sys/kernel/debug/kfuzztest/%s/input"= , target_name); + if (ret < 0) + return ret; + + fd =3D openat(AT_FDCWD, buf, O_WRONLY, 0); + if (fd < 0) + return fd; + + bytes_written =3D write(fd, (void *)data, data_size); + if (bytes_written < 0) { + close(fd); + return bytes_written; + } + + if (close(fd) !=3D 0) + return 1; + return 0; +} + +static int invoke_one(const char *input_fmt, const char *fuzz_target, cons= t char *input_filepath) +{ + struct ast_node *ast_prog; + struct byte_buffer *bb; + struct rand_stream *rs; + struct token **tokens; + size_t num_tokens; + size_t num_bytes; + int err; + + err =3D tokenize(input_fmt, &tokens, &num_tokens); + if (err) { + printf("tokenization failed: %s\n", strerror(-err)); + return err; + } + + err =3D parse(tokens, num_tokens, &ast_prog); + if (err) { + printf("parsing failed: %s\n", strerror(-err)); + return err; + } + + rs =3D new_rand_stream(input_filepath, 1024); + err =3D encode(ast_prog, rs, &num_bytes, &bb); + if (err) { + printf("encoding failed: %s\n", strerror(-err)); + return err; + } + + err =3D invoke_kfuzztest_target(fuzz_target, bb->buffer, num_bytes); + if (err) { + printf("invocation failed: %s\n", strerror(-err)); + return err; + } + destroy_byte_buffer(bb); + return err; +} + +int main(int argc, char *argv[]) +{ + if (argc !=3D 4) { + printf("Usage: %s \n"= , argv[0]); + printf("For more detailed information see /Documentation/dev-tools/kfuzz= test.rst\n"); + return 1; + } + + return invoke_one(argv[1], argv[2], argv[3]); +} diff --git a/tools/kfuzztest-bridge/byte_buffer.c b/tools/kfuzztest-bridge/= byte_buffer.c new file mode 100644 index 000000000000..fafb036fbeb1 --- /dev/null +++ b/tools/kfuzztest-bridge/byte_buffer.c @@ -0,0 +1,87 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * A simple byte buffer implementation for encoding binary data + * + * Copyright 2025 Google LLC + */ +#include +#include +#include + +#include "byte_buffer.h" + +struct byte_buffer *new_byte_buffer(size_t initial_size) +{ + struct byte_buffer *ret; + size_t alloc_size =3D initial_size >=3D 8 ? initial_size : 8; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return NULL; + + ret->alloc_size =3D alloc_size; + ret->buffer =3D malloc(alloc_size); + if (!ret->buffer) { + free(ret); + return NULL; + } + ret->num_bytes =3D 0; + return ret; +} + +void destroy_byte_buffer(struct byte_buffer *buf) +{ + free(buf->buffer); + free(buf); +} + +int append_bytes(struct byte_buffer *buf, const char *bytes, size_t num_by= tes) +{ + size_t req_size; + size_t new_size; + char *new_ptr; + + req_size =3D buf->num_bytes + num_bytes; + new_size =3D buf->alloc_size; + + while (req_size > new_size) + new_size *=3D 2; + if (new_size !=3D buf->alloc_size) { + new_ptr =3D realloc(buf->buffer, new_size); + if (!buf->buffer) + return -ENOMEM; + buf->buffer =3D new_ptr; + buf->alloc_size =3D new_size; + } + memcpy(buf->buffer + buf->num_bytes, bytes, num_bytes); + buf->num_bytes +=3D num_bytes; + return 0; +} + +int append_byte(struct byte_buffer *buf, char c) +{ + return append_bytes(buf, &c, 1); +} + +int encode_le(struct byte_buffer *buf, uint64_t value, size_t byte_width) +{ + size_t i; + int ret; + + for (i =3D 0; i < byte_width; ++i) { + if ((ret =3D append_byte(buf, (uint8_t)((value >> (i * 8)) & 0xFF)))) { + return ret; + } + } + return 0; +} + +int pad(struct byte_buffer *buf, size_t num_padding) +{ + int ret; + size_t i; + for (i =3D 0; i < num_padding; i++) + if ((ret =3D append_byte(buf, 0))) + return ret; + return 0; +} diff --git a/tools/kfuzztest-bridge/byte_buffer.h b/tools/kfuzztest-bridge/= byte_buffer.h new file mode 100644 index 000000000000..6a31bfb5e78f --- /dev/null +++ b/tools/kfuzztest-bridge/byte_buffer.h @@ -0,0 +1,31 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * A simple byte buffer implementation for encoding binary data + * + * Copyright 2025 Google LLC + */ +#ifndef KFUZZTEST_BRIDGE_BYTE_BUFFER_H +#define KFUZZTEST_BRIDGE_BYTE_BUFFER_H + +#include +#include + +struct byte_buffer { + char *buffer; + size_t num_bytes; + size_t alloc_size; +}; + +struct byte_buffer *new_byte_buffer(size_t initial_size); + +void destroy_byte_buffer(struct byte_buffer *buf); + +int append_bytes(struct byte_buffer *buf, const char *bytes, size_t num_by= tes); + +int append_byte(struct byte_buffer *buf, char c); + +int encode_le(struct byte_buffer *buf, uint64_t value, size_t byte_width); + +int pad(struct byte_buffer *buf, size_t num_padding); + +#endif /* KFUZZTEST_BRIDGE_BYTE_BUFFER_H */ diff --git a/tools/kfuzztest-bridge/encoder.c b/tools/kfuzztest-bridge/enco= der.c new file mode 100644 index 000000000000..ceddd78ddbb5 --- /dev/null +++ b/tools/kfuzztest-bridge/encoder.c @@ -0,0 +1,356 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Encoder for KFuzzTest binary input format + * + * Copyright 2025 Google LLC + */ +#include +#include +#include +#include +#include + +#include "byte_buffer.h" +#include "input_parser.h" +#include "rand_stream.h" + +#define KFUZZTEST_MAGIC 0xBFACE +#define KFUZZTEST_PROTO_VERSION 0 +/*=20 + * The KFuzzTest binary input format requires at least 8 bytes of padding + * at the head and tail of every region. + */ +#define KFUZZTEST_POISON_SIZE 8 + +#define BUFSIZE_SMALL 32 +#define BUFSIZE_LARGE 128 + +struct region_info { + const char *name; + uint32_t offset; + uint32_t size; +}; + +struct reloc_info { + uint32_t src_reg; + uint32_t offset; + uint32_t dst_reg; +}; + +struct encoder_ctx { + struct byte_buffer *payload; + struct rand_stream *rand; + + struct region_info *regions; + size_t num_regions; + + struct reloc_info *relocations; + size_t num_relocations; + + size_t reg_offset; + int curr_reg; +}; + +static void cleanup_ctx(struct encoder_ctx *ctx) +{ + if (ctx->regions) + free(ctx->regions); + if (ctx->relocations) + free(ctx->relocations); + if (ctx->payload) + destroy_byte_buffer(ctx->payload); +} + +static int pad_payload(struct encoder_ctx *ctx, size_t amount) +{ + int ret; + + if ((ret =3D pad(ctx->payload, amount))) + return ret; + ctx->reg_offset +=3D amount; + return 0; +} + +static int align_payload(struct encoder_ctx *ctx, size_t alignment) +{ + size_t pad_amount =3D ROUND_UP_TO_MULTIPLE(ctx->payload->num_bytes, align= ment) - ctx->payload->num_bytes; + return pad_payload(ctx, pad_amount); +} + +static int lookup_reg(struct encoder_ctx *ctx, const char *name) +{ + size_t i; + + for (i =3D 0; i < ctx->num_regions; i++) { + if (strcmp(ctx->regions[i].name, name) =3D=3D 0) + return i; + } + return -ENOENT; +} + +static int add_reloc(struct encoder_ctx *ctx, struct reloc_info reloc) +{ + void *new_ptr =3D realloc(ctx->relocations, (ctx->num_relocations + 1) * = sizeof(struct reloc_info)); + if (!new_ptr) + return -ENOMEM; + + ctx->relocations =3D new_ptr; + ctx->relocations[ctx->num_relocations] =3D reloc; + ctx->num_relocations++; + return 0; +} + +static int build_region_map(struct encoder_ctx *ctx, struct ast_node *top_= level) +{ + struct ast_program *prog; + struct ast_node *reg; + size_t i; + + if (top_level->type !=3D NODE_PROGRAM) + return -EINVAL; + + prog =3D &top_level->data.program; + ctx->regions =3D malloc(prog->num_members * sizeof(struct region_info)); + if (!ctx->regions) + return -ENOMEM; + + ctx->num_regions =3D prog->num_members; + for (i =3D 0; i < ctx->num_regions; i++) { + reg =3D prog->members[i]; + /* Offset can only be determined after the second pass. */ + ctx->regions[i] =3D (struct region_info){ + .name =3D reg->data.region.name, + .size =3D node_size(reg), + }; + } + return 0; +} +/** + * Encodes a value node as little-endian. A value node is one that has no + * children, and can therefore be directly written into the payload. + */ +static int encode_value_le(struct encoder_ctx *ctx, struct ast_node *node) +{ + size_t array_size; + char rand_char; + size_t length; + size_t i; + int reg; + int ret; + + switch (node->type) { + case NODE_ARRAY: + array_size =3D node->data.array.num_elems * node->data.array.elem_size; + for (i =3D 0; i < array_size; i++) { + if ((ret =3D next_byte(ctx->rand, &rand_char))) + return ret; + if ((ret =3D append_byte(ctx->payload, rand_char))) + return ret; + } + ctx->reg_offset +=3D array_size; + if (node->data.array.null_terminated) { + if ((ret =3D pad_payload(ctx, 1))) + return ret; + ctx->reg_offset++; + } + break; + case NODE_LENGTH: + reg =3D lookup_reg(ctx, node->data.length.length_of); + if (reg < 0) + return reg; + length =3D ctx->regions[reg].size; + if ((ret =3D encode_le(ctx->payload, length, node->data.length.byte_widt= h))) + return ret; + ctx->reg_offset +=3D node->data.length.byte_width; + break; + case NODE_PRIMITIVE: + for (i =3D 0; i < node->data.primitive.byte_width; i++) { + if ((ret =3D next_byte(ctx->rand, &rand_char))) + return ret; + if ((ret =3D append_byte(ctx->payload, rand_char))) + return ret; + } + ctx->reg_offset +=3D node->data.primitive.byte_width; + break; + case NODE_POINTER: + reg =3D lookup_reg(ctx, node->data.pointer.points_to); + if (reg < 0) + return reg; + if ((ret =3D add_reloc(ctx, (struct reloc_info){ .src_reg =3D ctx->curr_= reg, + .offset =3D ctx->reg_offset, + .dst_reg =3D reg }))) + return ret; + /* Placeholder pointer value, as pointers are patched by KFuzzTest anywa= ys. */ + if ((ret =3D encode_le(ctx->payload, UINTPTR_MAX, sizeof(uintptr_t)))) + return ret; + ctx->reg_offset +=3D sizeof(uintptr_t); + break; + case NODE_PROGRAM: + case NODE_REGION: + default: + return -EINVAL; + } + return 0; +} + +static int encode_region(struct encoder_ctx *ctx, struct ast_region *reg) +{ + struct ast_node *child; + size_t i; + int ret; + + ctx->reg_offset =3D 0; + for (i =3D 0; i < reg->num_members; i++) { + child =3D reg->members[i]; + if ((ret =3D align_payload(ctx, node_alignment(child)))) + return ret; + if ((ret =3D encode_value_le(ctx, child))) + return ret; + } + return 0; +} + +static int encode_payload(struct encoder_ctx *ctx, struct ast_node *top_le= vel) +{ + struct ast_node *reg; + size_t i; + int ret; + + for (i =3D 0; i < ctx->num_regions; i++) { + reg =3D top_level->data.program.members[i]; + if ((ret =3D align_payload(ctx, node_alignment(reg)))) + return ret; + + ctx->curr_reg =3D i; + ctx->regions[i].offset =3D ctx->payload->num_bytes; + if ((ret =3D encode_region(ctx, ®->data.region))) + return ret; + if ((ret =3D pad_payload(ctx, KFUZZTEST_POISON_SIZE))) + return ret; + } + return 0; +} + +static int encode_region_array(struct encoder_ctx *ctx, struct byte_buffer= **ret) +{ + struct byte_buffer *reg_array; + struct region_info info; + int retcode; + size_t i; + + reg_array =3D new_byte_buffer(BUFSIZE_SMALL); + if (!reg_array) + return -ENOMEM; + + if ((retcode =3D encode_le(reg_array, ctx->num_regions, sizeof(uint32_t))= )) + goto fail; + + for (i =3D 0; i < ctx->num_regions; i++) { + info =3D ctx->regions[i]; + if ((retcode =3D encode_le(reg_array, info.offset, sizeof(uint32_t)))) + goto fail; + if ((retcode =3D encode_le(reg_array, info.size, sizeof(uint32_t)))) + goto fail; + } + *ret =3D reg_array; + return 0; + +fail: + destroy_byte_buffer(reg_array); + return retcode; +} + +static int encode_reloc_table(struct encoder_ctx *ctx, size_t padding_amou= nt, struct byte_buffer **ret) +{ + struct byte_buffer *reloc_table; + struct reloc_info info; + int retcode; + size_t i; + + reloc_table =3D new_byte_buffer(BUFSIZE_SMALL); + if (!reloc_table) + return -ENOMEM; + + if ((retcode =3D encode_le(reloc_table, ctx->num_relocations, sizeof(uint= 32_t))) || + (retcode =3D encode_le(reloc_table, padding_amount, sizeof(uint32_t))= )) + goto fail; + + for (i =3D 0; i < ctx->num_relocations; i++) { + info =3D ctx->relocations[i]; + if ((retcode =3D encode_le(reloc_table, info.src_reg, sizeof(uint32_t)))= || + (retcode =3D encode_le(reloc_table, info.offset, sizeof(uint32_t))) = || + (retcode =3D encode_le(reloc_table, info.dst_reg, sizeof(uint32_t)))) + goto fail; + } + pad(reloc_table, padding_amount); + *ret =3D reloc_table; + return 0; + +fail: + destroy_byte_buffer(reloc_table); + return retcode; +} + +static size_t reloc_table_size(struct encoder_ctx *ctx) +{ + return 2 * sizeof(uint32_t) + 3 * ctx->num_relocations * sizeof(uint32_t); +} + +int encode(struct ast_node *top_level, struct rand_stream *r, size_t *num_= bytes, struct byte_buffer **ret) +{ + struct byte_buffer *region_array =3D NULL; + struct byte_buffer *final_buffer =3D NULL; + struct byte_buffer *reloc_table =3D NULL; + size_t header_size; + int alignment; + int retcode; + + struct encoder_ctx ctx =3D { 0 }; + if ((retcode =3D build_region_map(&ctx, top_level))) + goto fail; + + ctx.rand =3D r; + ctx.payload =3D new_byte_buffer(32); + if (!ctx.payload) { + retcode =3D -ENOMEM; + goto fail; + } + if ((retcode =3D encode_payload(&ctx, top_level))) + goto fail; + + if ((retcode =3D encode_region_array(&ctx, ®ion_array))) + goto fail; + + header_size =3D sizeof(uint64_t) + region_array->num_bytes + reloc_table_= size(&ctx); + alignment =3D node_alignment(top_level); + if ((retcode =3D encode_reloc_table( + &ctx, ROUND_UP_TO_MULTIPLE(header_size + KFUZZTEST_POISON_SIZE, ali= gnment) - header_size, + &reloc_table))) + goto fail; + + final_buffer =3D new_byte_buffer(BUFSIZE_LARGE); + if (!final_buffer) { + retcode =3D -ENOMEM; + goto fail; + } + + if ((retcode =3D encode_le(final_buffer, KFUZZTEST_MAGIC, sizeof(uint32_t= ))) || + (retcode =3D encode_le(final_buffer, KFUZZTEST_PROTO_VERSION, sizeof(= uint32_t))) || + (retcode =3D append_bytes(final_buffer, region_array->buffer, region_= array->num_bytes)) || + (retcode =3D append_bytes(final_buffer, reloc_table->buffer, reloc_ta= ble->num_bytes)) || + (retcode =3D append_bytes(final_buffer, ctx.payload->buffer, ctx.payl= oad->num_bytes))) { + destroy_byte_buffer(final_buffer); + goto fail; + } + + *num_bytes =3D final_buffer->num_bytes; + *ret =3D final_buffer; + +fail: + if (region_array) + destroy_byte_buffer(region_array); + if (reloc_table) + destroy_byte_buffer(reloc_table); + cleanup_ctx(&ctx); + return retcode; +} diff --git a/tools/kfuzztest-bridge/encoder.h b/tools/kfuzztest-bridge/enco= der.h new file mode 100644 index 000000000000..73f8c4b7893c --- /dev/null +++ b/tools/kfuzztest-bridge/encoder.h @@ -0,0 +1,16 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Encoder for KFuzzTest binary input format + * + * Copyright 2025 Google LLC + */ +#ifndef KFUZZTEST_BRIDGE_ENCODER_H +#define KFUZZTEST_BRIDGE_ENCODER_H + +#include "input_parser.h" +#include "rand_stream.h" +#include "byte_buffer.h" + +int encode(struct ast_node *top_level, struct rand_stream *r, size_t *num_= bytes, struct byte_buffer **ret); + +#endif /* KFUZZTEST_BRIDGE_ENCODER_H */ diff --git a/tools/kfuzztest-bridge/input_lexer.c b/tools/kfuzztest-bridge/= input_lexer.c new file mode 100644 index 000000000000..19b6678b0a0e --- /dev/null +++ b/tools/kfuzztest-bridge/input_lexer.c @@ -0,0 +1,243 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Parser for KFuzzTest textual input format + * + * Copyright 2025 Google LLC + */ +#include +#include +#include +#include +#include +#include + +#include "input_lexer.h" + +struct keyword_map { + const char *keyword; + enum token_type type; +}; + +static struct keyword_map keywords[] =3D { + { "ptr", TOKEN_KEYWORD_PTR }, { "arr", TOKEN_KEYWORD_ARR }, { "len", TOKE= N_KEYWORD_LEN }, + { "str", TOKEN_KEYWORD_STR }, { "u8", TOKEN_KEYWORD_U8 }, { "u16", TOKE= N_KEYWORD_U16 }, + { "u32", TOKEN_KEYWORD_U32 }, { "u64", TOKEN_KEYWORD_U64 }, +}; + +static struct token *make_token(enum token_type type) +{ + struct token *ret =3D calloc(1, sizeof(*ret)); + ret->type =3D type; + return ret; +} + +struct lexer { + const char *start; + const char *current; +}; + +static char advance(struct lexer *l) +{ + l->current++; + return l->current[-1]; +} + +static void retreat(struct lexer *l) +{ + l->current--; +} + +static char peek(struct lexer *l) +{ + return *l->current; +} + +static bool is_digit(char c) +{ + return c >=3D '0' && c <=3D '9'; +} + +static bool is_alpha(char c) +{ + return (c >=3D 'a' && c <=3D 'z') || (c >=3D 'A' && c <=3D 'Z'); +} + +static bool is_whitespace(char c) +{ + switch (c) { + case ' ': + case '\r': + case '\t': + case '\n': + return true; + default: + return false; + } +} + +static void skip_whitespace(struct lexer *l) +{ + for (;;) { + if (is_whitespace(peek(l))) { + advance(l); + } else { + return; + } + } +} + +static struct token *number(struct lexer *l) +{ + struct token *tok; + uint64_t value; + while (is_digit(peek(l))) + advance(l); + value =3D strtoull(l->start, NULL, 10); + tok =3D make_token(TOKEN_INTEGER); + tok->data.integer =3D value; + return tok; +} + +static enum token_type check_keyword(struct lexer *l, const char *keyword,= enum token_type type) +{ + size_t len =3D strlen(keyword); + + if (((size_t)(l->current - l->start) =3D=3D len) && strncmp(l->start, key= word, len) =3D=3D 0) + return type; + return TOKEN_IDENTIFIER; +} + +static struct token *identifier(struct lexer *l) +{ + enum token_type type =3D TOKEN_IDENTIFIER; + struct token *tok; + size_t i; + + while (is_digit(peek(l)) || is_alpha(peek(l)) || peek(l) =3D=3D '_') + advance(l); + + for (i =3D 0; i < ARRAY_SIZE(keywords); i++) { + if (check_keyword(l, keywords[i].keyword, keywords[i].type) !=3D TOKEN_I= DENTIFIER) { + type =3D keywords[i].type; + break; + } + } + + tok =3D make_token(type); + if (!tok) + return NULL; + if (type =3D=3D TOKEN_IDENTIFIER) { + tok->data.identifier.start =3D l->start; + tok->data.identifier.length =3D l->current - l->start; + } + return tok; +} + +static struct token *scan_token(struct lexer *l) +{ + char c; + skip_whitespace(l); + + l->start =3D l->current; + c =3D peek(l); + + if (c =3D=3D '\0') + return make_token(TOKEN_EOF); + + advance(l); + switch (c) { + case '{': + return make_token(TOKEN_LBRACE); + case '}': + return make_token(TOKEN_RBRACE); + case '[': + return make_token(TOKEN_LBRACKET); + case ']': + return make_token(TOKEN_RBRACKET); + case ',': + return make_token(TOKEN_COMMA); + case ';': + return make_token(TOKEN_SEMICOLON); + default: + retreat(l); + if (is_digit(c)) + return number(l); + if (is_alpha(c) || c =3D=3D '_') + return identifier(l); + return make_token(TOKEN_ERROR); + } +} + +int primitive_byte_width(enum token_type type) +{ + switch (type) { + case TOKEN_KEYWORD_U8: + return 1; + case TOKEN_KEYWORD_U16: + return 2; + case TOKEN_KEYWORD_U32: + return 4; + case TOKEN_KEYWORD_U64: + return 8; + default: + return 0; + } +} + +int tokenize(const char *input, struct token ***tokens, size_t *num_tokens) +{ + struct lexer l =3D { .start =3D input, .current =3D input }; + struct token **ret_tokens; + size_t token_arr_size; + size_t token_count; + struct token *tok; + void *tmp; + size_t i; + int err; + + token_arr_size =3D 128; + ret_tokens =3D calloc(token_arr_size, sizeof(struct token *)); + if (!ret_tokens) + return -ENOMEM; + + token_count =3D 0; + do { + tok =3D scan_token(&l); + if (!tok) { + err =3D -ENOMEM; + goto failure; + } + + if (token_count =3D=3D token_arr_size) { + token_arr_size *=3D 2; + tmp =3D realloc(ret_tokens, token_arr_size); + if (!tmp) { + err =3D -ENOMEM; + goto failure; + } + ret_tokens =3D tmp; + } + + ret_tokens[token_count] =3D tok; + if (tok->type =3D=3D TOKEN_ERROR) { + err =3D -EINVAL; + goto failure; + } + token_count++; + } while (tok->type !=3D TOKEN_EOF); + + *tokens =3D ret_tokens; + *num_tokens =3D token_count; + return 0; + +failure: + for (i =3D 0; i < token_count; i++) + free(ret_tokens[i]); + free(ret_tokens); + return err; +} + +bool is_primitive(struct token *tok) +{ + return tok->type >=3D TOKEN_KEYWORD_U8 && tok->type <=3D TOKEN_KEYWORD_U6= 4; +} diff --git a/tools/kfuzztest-bridge/input_lexer.h b/tools/kfuzztest-bridge/= input_lexer.h new file mode 100644 index 000000000000..bdc55e08a3eb --- /dev/null +++ b/tools/kfuzztest-bridge/input_lexer.h @@ -0,0 +1,57 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Lexer for KFuzzTest textual input format + * + * Copyright 2025 Google LLC + */ +#ifndef KFUZZTEST_BRIDGE_INPUT_LEXER_H +#define KFUZZTEST_BRIDGE_INPUT_LEXER_H + +#include +#include +#include + +#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0])) + +enum token_type { + TOKEN_LBRACE, + TOKEN_RBRACE, + TOKEN_LBRACKET, + TOKEN_RBRACKET, + TOKEN_COMMA, + TOKEN_SEMICOLON, + + TOKEN_KEYWORD_PTR, + TOKEN_KEYWORD_ARR, + TOKEN_KEYWORD_LEN, + TOKEN_KEYWORD_STR, + TOKEN_KEYWORD_U8, + TOKEN_KEYWORD_U16, + TOKEN_KEYWORD_U32, + TOKEN_KEYWORD_U64, + + TOKEN_IDENTIFIER, + TOKEN_INTEGER, + + TOKEN_EOF, + TOKEN_ERROR, +}; + +struct token { + enum token_type type; + union { + uint64_t integer; + struct { + const char *start; + size_t length; + } identifier; + } data; + int position; +}; + +int tokenize(const char *input, struct token ***tokens, size_t *num_tokens= ); + +bool is_primitive(struct token *tok); +int primitive_byte_width(enum token_type type); + +#endif /* KFUZZTEST_BRIDGE_INPUT_LEXER_H */ diff --git a/tools/kfuzztest-bridge/input_parser.c b/tools/kfuzztest-bridge= /input_parser.c new file mode 100644 index 000000000000..7320dac8aa17 --- /dev/null +++ b/tools/kfuzztest-bridge/input_parser.c @@ -0,0 +1,373 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Parser for KFuzzTest textual input format + * + * Copyright 2025 Google LLC + */ +#include +#include +#include + +#include "input_lexer.h" +#include "input_parser.h" + +#define MAX(a, b) ((a) > (b) ? (a) : (b)) + +static struct token *peek(struct parser *p) +{ + return p->tokens[p->curr_token]; +} + +static struct token *advance(struct parser *p) +{ + struct token *tok =3D peek(p); + p->curr_token++; + return tok; +} + +static struct token *consume(struct parser *p, enum token_type type, const= char *err_msg) +{ + if (peek(p)->type !=3D type) { + printf("parser failure: %s\n", err_msg); + return NULL; + } + return advance(p); +} + +static bool match(struct parser *p, enum token_type t) +{ + struct token *tok =3D peek(p); + return tok->type =3D=3D t; +} + +static int parse_primitive(struct parser *p, struct ast_node **node_ret) +{ + struct ast_node *ret; + struct token *tok; + int byte_width; + + tok =3D advance(p); + byte_width =3D primitive_byte_width(tok->type); + if (!byte_width) + return -EINVAL; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return -ENOMEM; + + ret->type =3D NODE_PRIMITIVE; + ret->data.primitive.byte_width =3D byte_width; + *node_ret =3D ret; + return 0; +} + +static int parse_ptr(struct parser *p, struct ast_node **node_ret) +{ + const char *points_to; + struct ast_node *ret; + struct token *tok; + if (!consume(p, TOKEN_KEYWORD_PTR, "expected 'ptr'")) + return -EINVAL; + if (!consume(p, TOKEN_LBRACKET, "expected '['")) + return -EINVAL; + + tok =3D consume(p, TOKEN_IDENTIFIER, "expected identifier"); + if (!tok) + return -EINVAL; + + if (!consume(p, TOKEN_RBRACKET, "expected ']'")) + return -EINVAL; + + ret =3D malloc(sizeof(*ret)); + ret->type =3D NODE_POINTER; + + points_to =3D strndup(tok->data.identifier.start, tok->data.identifier.le= ngth); + if (!points_to) { + free(ret); + return -EINVAL; + } + + ret->data.pointer.points_to =3D points_to; + *node_ret =3D ret; + return 0; +} + +static int parse_arr(struct parser *p, struct ast_node **node_ret) +{ + struct token *type, *num_elems; + struct ast_node *ret; + + if (!consume(p, TOKEN_KEYWORD_ARR, "expected 'arr'") || !consume(p, TOKEN= _LBRACKET, "expected '['")) + return -EINVAL; + + type =3D advance(p); + if (!is_primitive(type)) + return -EINVAL; + + if (!consume(p, TOKEN_COMMA, "expected ','")) + return -EINVAL; + + num_elems =3D consume(p, TOKEN_INTEGER, "expected integer"); + if (!num_elems) + return -EINVAL; + + if (!consume(p, TOKEN_RBRACKET, "expected ']'")) + return -EINVAL; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return -ENOMEM; + + ret->type =3D NODE_ARRAY; + ret->data.array.num_elems =3D num_elems->data.integer; + ret->data.array.elem_size =3D primitive_byte_width(type->type); + ret->data.array.null_terminated =3D false; + *node_ret =3D ret; + return 0; +} + +static int parse_str(struct parser *p, struct ast_node **node_ret) +{ + struct ast_node *ret; + struct token *len; + + if (!consume(p, TOKEN_KEYWORD_STR, "expected 'str'") || !consume(p, TOKEN= _LBRACKET, "expected '['")) + return -EINVAL; + + len =3D consume(p, TOKEN_INTEGER, "expected integer"); + if (!len) + return -EINVAL; + + if (!consume(p, TOKEN_RBRACKET, "expected ']'")) + return -EINVAL; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return -ENOMEM; + + /* A string is the susbet of byte arrays that are null-terminated. */ + ret->type =3D NODE_ARRAY; + ret->data.array.num_elems =3D len->data.integer; + ret->data.array.elem_size =3D sizeof(char); + ret->data.array.null_terminated =3D true; + *node_ret =3D ret; + return 0; +} + +static int parse_len(struct parser *p, struct ast_node **node_ret) +{ + struct token *type, *len; + struct ast_node *ret; + + if (!consume(p, TOKEN_KEYWORD_LEN, "expected 'len'") || !consume(p, TOKEN= _LBRACKET, "expected '['")) + return -EINVAL; + + len =3D advance(p); + if (len->type !=3D TOKEN_IDENTIFIER) + return -EINVAL; + + if (!consume(p, TOKEN_COMMA, "expected ','")) + return -EINVAL; + + type =3D advance(p); + if (!is_primitive(type)) + return -EINVAL; + + if (!consume(p, TOKEN_RBRACKET, "expected ']'")) + return -EINVAL; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return -ENOMEM; + ret->type =3D NODE_LENGTH; + ret->data.length.length_of =3D strndup(len->data.identifier.start, len->d= ata.identifier.length); + ret->data.length.byte_width =3D primitive_byte_width(type->type); + + *node_ret =3D ret; + return 0; +} + +static int parse_type(struct parser *p, struct ast_node **node_ret) +{ + if (is_primitive(peek(p))) + return parse_primitive(p, node_ret); + + if (peek(p)->type =3D=3D TOKEN_KEYWORD_PTR) + return parse_ptr(p, node_ret); + + if (peek(p)->type =3D=3D TOKEN_KEYWORD_ARR) + return parse_arr(p, node_ret); + + if (peek(p)->type =3D=3D TOKEN_KEYWORD_STR) + return parse_str(p, node_ret); + + if (peek(p)->type =3D=3D TOKEN_KEYWORD_LEN) + return parse_len(p, node_ret); + + return -EINVAL; +} + +static int parse_region(struct parser *p, struct ast_node **node_ret) +{ + struct token *tok, *identifier; + struct ast_region *region; + struct ast_node *node; + struct ast_node *ret; + size_t i; + int err; + + identifier =3D consume(p, TOKEN_IDENTIFIER, "expected identifier"); + if (!identifier) + return -EINVAL; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return -ENOMEM; + + tok =3D consume(p, TOKEN_LBRACE, "expected '{'"); + if (!tok) { + err =3D -EINVAL; + goto fail_early; + } + + region =3D &ret->data.region; + region->name =3D strndup(identifier->data.identifier.start, identifier->d= ata.identifier.length); + if (!region->name) { + err =3D -ENOMEM; + goto fail_early; + } + + region->num_members =3D 0; + while (!match(p, TOKEN_RBRACE)) { + err =3D parse_type(p, &node); + if (err) + goto fail; + region->members =3D realloc(region->members, ++region->num_members * siz= eof(struct ast_node *)); + region->members[region->num_members - 1] =3D node; + } + + if (!consume(p, TOKEN_RBRACE, "expected '}'") || !consume(p, TOKEN_SEMICO= LON, "expected ';'")) { + err =3D -EINVAL; + goto fail; + } + + ret->type =3D NODE_REGION; + *node_ret =3D ret; + return 0; + +fail: + for (i =3D 0; i < region->num_members; i++) + free(region->members[i]); + free((void *)region->name); + free(region->members); +fail_early: + free(ret); + return err; +} + +static int parse_program(struct parser *p, struct ast_node **node_ret) +{ + struct ast_program *prog; + struct ast_node *reg; + struct ast_node *ret; + void *new_ptr; + size_t i; + int err; + + ret =3D malloc(sizeof(*ret)); + if (!ret) + return -ENOMEM; + ret->type =3D NODE_PROGRAM; + + prog =3D &ret->data.program; + prog->num_members =3D 0; + prog->members =3D NULL; + while (!match(p, TOKEN_EOF)) { + err =3D parse_region(p, ®); + if (err) + goto fail; + + new_ptr =3D realloc(prog->members, ++prog->num_members * sizeof(struct a= st_node *)); + if (!new_ptr) { + err =3D -ENOMEM; + goto fail; + } + prog->members =3D new_ptr; + prog->members[prog->num_members - 1] =3D reg; + } + + *node_ret =3D ret; + return 0; + +fail: + for (i =3D 0; i < prog->num_members; i++) + free(prog->members[i]); + free(prog->members); + free(ret); + return err; +} + +size_t node_alignment(struct ast_node *node) +{ + size_t max_alignment =3D 1; + size_t i; + + switch (node->type) { + case NODE_PROGRAM: + for (i =3D 0; i < node->data.program.num_members; i++) + max_alignment =3D MAX(max_alignment, node_alignment(node->data.program.= members[i])); + return max_alignment; + case NODE_REGION: + for (i =3D 0; i < node->data.region.num_members; i++) + max_alignment =3D MAX(max_alignment, node_alignment(node->data.region.m= embers[i])); + return max_alignment; + case NODE_ARRAY: + return node->data.array.elem_size; + case NODE_LENGTH: + return node->data.length.byte_width; + case NODE_PRIMITIVE: + /* Primitives are aligned to their size. */ + return node->data.primitive.byte_width; + case NODE_POINTER: + return sizeof(uintptr_t); + } + + /* Anything should be at least 1-byte-aligned. */ + return 1; +} + +size_t node_size(struct ast_node *node) +{ + size_t total =3D 0; + size_t i; + + switch (node->type) { + case NODE_PROGRAM: + for (i =3D 0; i < node->data.program.num_members; i++) + total +=3D node_size(node->data.program.members[i]); + return total; + case NODE_REGION: + for (i =3D 0; i < node->data.region.num_members; i++) { + /* Account for padding within region. */ + total =3D ROUND_UP_TO_MULTIPLE(total, node_alignment(node->data.region.= members[i])); + total +=3D node_size(node->data.region.members[i]); + } + return total; + case NODE_ARRAY: + return node->data.array.elem_size * node->data.array.num_elems + + (node->data.array.null_terminated ? 1 : 0); + case NODE_LENGTH: + return node->data.length.byte_width; + case NODE_PRIMITIVE: + return node->data.primitive.byte_width; + case NODE_POINTER: + return sizeof(uintptr_t); + } + return 0; +} + +int parse(struct token **tokens, size_t token_count, struct ast_node **nod= e_ret) +{ + struct parser p =3D { .tokens =3D tokens, .token_count =3D token_count, .= curr_token =3D 0 }; + return parse_program(&p, node_ret); +} diff --git a/tools/kfuzztest-bridge/input_parser.h b/tools/kfuzztest-bridge= /input_parser.h new file mode 100644 index 000000000000..c51241617389 --- /dev/null +++ b/tools/kfuzztest-bridge/input_parser.h @@ -0,0 +1,79 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Parser for KFuzzTest textual input format + * + * Copyright 2025 Google LLC + */ +#ifndef KFUZZTEST_BRIDGE_INPUT_PARSER_H +#define KFUZZTEST_BRIDGE_INPUT_PARSER_H + +#include + +/* Rounds x up to the nearest multiple of n. */ +#define ROUND_UP_TO_MULTIPLE(x, n) (((n) =3D=3D 0) ? (0) : (((x) + (n) - 1= ) / (n)) * (n)) + +enum ast_node_type { + NODE_PROGRAM, + NODE_REGION, + NODE_ARRAY, + NODE_LENGTH, + NODE_PRIMITIVE, + NODE_POINTER, +}; + +struct ast_node; /* Forward declaration. */ + +struct ast_program { + struct ast_node **members; + size_t num_members; +}; + +struct ast_region { + const char *name; + struct ast_node **members; + size_t num_members; +}; + +struct ast_array { + int elem_size; + int null_terminated; /* True iff the array should always end with 0. */ + size_t num_elems; +}; + +struct ast_length { + size_t byte_width; + const char *length_of; +}; + +struct ast_primitive { + size_t byte_width; +}; + +struct ast_pointer { + const char *points_to; +}; + +struct ast_node { + enum ast_node_type type; + union { + struct ast_program program; + struct ast_region region; + struct ast_array array; + struct ast_length length; + struct ast_primitive primitive; + struct ast_pointer pointer; + } data; +}; + +struct parser { + struct token **tokens; + size_t token_count; + size_t curr_token; +}; + +int parse(struct token **tokens, size_t token_count, struct ast_node **nod= e_ret); + +size_t node_size(struct ast_node *node); +size_t node_alignment(struct ast_node *node); + +#endif /* KFUZZTEST_BRIDGE_INPUT_PARSER_H */ diff --git a/tools/kfuzztest-bridge/rand_stream.c b/tools/kfuzztest-bridge/= rand_stream.c new file mode 100644 index 000000000000..0b2965fa2c73 --- /dev/null +++ b/tools/kfuzztest-bridge/rand_stream.c @@ -0,0 +1,61 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Implements a cached file-reader for iterating over a byte stream of + * pseudo-random data + * + * Copyright 2025 Google LLC + */ +#include "rand_stream.h" + +static int refill(struct rand_stream *rs) +{ + size_t ret =3D fread(rs->buffer, sizeof(char), rs->buffer_size, rs->sourc= e); + rs->buffer_pos =3D 0; + if (ret !=3D rs->buffer_size) + return -1; + return 0; +} + +struct rand_stream *new_rand_stream(const char *path_to_file, size_t cache= _size) +{ + struct rand_stream *rs; + + rs =3D malloc(sizeof(*rs)); + if (!rs) + return NULL; + + rs->source =3D fopen(path_to_file, "rb"); + if (!rs->source) { + free(rs); + return NULL; + } + + rs->buffer =3D malloc(cache_size); + if (!rs->buffer) { + fclose(rs->source); + free(rs); + return NULL; + } + + rs->buffer_size =3D cache_size; + if (refill(rs)) { + free(rs->buffer); + fclose(rs->source); + free(rs); + return NULL; + } + + return rs; +} + +int next_byte(struct rand_stream *rs, char *ret) +{ + int res; + if (rs->buffer_pos =3D=3D rs->buffer_size) { + res =3D refill(rs); + if (res) + return res; + } + *ret =3D rs->buffer[rs->buffer_pos++]; + return 0; +} diff --git a/tools/kfuzztest-bridge/rand_stream.h b/tools/kfuzztest-bridge/= rand_stream.h new file mode 100644 index 000000000000..3367376758a5 --- /dev/null +++ b/tools/kfuzztest-bridge/rand_stream.h @@ -0,0 +1,46 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Implements a cached file-reader for iterating over a byte stream of + * pseudo-random data + * + * Copyright 2025 Google LLC + */ +#ifndef KFUZZTEST_BRIDGE_RAND_STREAM_H +#define KFUZZTEST_BRIDGE_RAND_STREAM_H + +#include +#include + +/** + * struct rand_stream - a cached bytestream reader + * + * Reads and returns bytes from a file, using cached pre-fetching to amort= ize + * the cost of reads. + */ +struct rand_stream { + FILE *source; + char *buffer; + size_t buffer_size; + size_t buffer_pos; +}; + +/** + * new_rand_stream - return a new struct rand_stream + * + * @path_to_file: source of the output byte stream. + * @cache_size: size of the read-ahead cache in bytes. + */ +struct rand_stream *new_rand_stream(const char *path_to_file, size_t cache= _size); + +/** + * next_byte - return the next byte from a struct rand_stream + * + * @rs: an initialized struct rand_stream. + * @ret: return pointer. + * + * @return 0 on success or a negative value on failure. + * + */ +int next_byte(struct rand_stream *rs, char *ret); + +#endif /* KFUZZTEST_BRIDGE_RAND_STREAM_H */ --=20 2.51.0.318.gd7df087d1a-goog From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wr1-f47.google.com (mail-wr1-f47.google.com [209.85.221.47]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 24EFE320A1F; Mon, 1 Sep 2025 16:43:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.47 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744998; cv=none; b=S/WJkY8NmvcK1rLWmPR9Jo9hJ5k/jdGCc38oCFahuTfZ7Yfih6XZzoRFmOk7sUZihpklVNfN3t3/9F9A0tB0hHEZKf4n/gXdAsW4X1Af0kmLW3EkjG1LoeQkixKSZzGRGBBOueL0lGihAZpiB6tCFD7Dk93Cdh8cpJT0llm3PI8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744998; c=relaxed/simple; bh=tMljM4CBiEWWHKzX77ua7xKmrSV6DvWqdBnITj2FrL4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=IXoxHG72cjgeBiB/T4NOl0JBOVoiZ+QUcnBtTpF/JD+c9Mn0FORrrLVl/TsoGQWftiblRbMqnlGyOc91yCpl+x30wmSg9/WlIYYeSnI47cdhgYpYyX7zQHYiLKQAOz8HYubET5Pbg2Oko5aN+8AsEtLXhD7xQNvMg9QvXC+cN5Q= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=ZHAw1zWX; arc=none smtp.client-ip=209.85.221.47 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ZHAw1zWX" Received: by mail-wr1-f47.google.com with SMTP id ffacd0b85a97d-3d0dd9c9229so2376799f8f.1; Mon, 01 Sep 2025 09:43:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744993; x=1757349793; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=+Q+lnz5hfxAJyxjEQHB9/QTS15Vi2TY+Ow6yqCRyLm4=; b=ZHAw1zWXZH6/EVRIRM5iYihdd0EJGb7VDg1/cZgK0rBvS1TsOKtNq184G1dxzfCUJ8 y7mR5+qiclun6J0bHRXWrxiVzk6ZfsLGTjMAfVlzMfBw8qY1uHmHZCNXYmWWEVxEkuVT /Ewpj5VvcPrJPyMpTbT8Lf2ENikTKM7lZjfa1GMkL//en2f+F+jXxyUd1t7bsL735KMb KpittrIHov0f9LZ7zWlOghyxxn8Hi2KVVD5DN1gmKqNP2Q1nmyCe+bw/PZbJrRLpf0qW JjGLxT1eSlFHrqie/p0hhk9QiQaF8TmKMNsjhVEf/5eGav8tbZL/3xQs0iwO8MrLnDZK O+Xw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744993; x=1757349793; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=+Q+lnz5hfxAJyxjEQHB9/QTS15Vi2TY+Ow6yqCRyLm4=; b=iOBU5iYeE3uR2iePaybf+dIbBv9VKzMx4leMdBitp8j0PRGl6/ofJhc99RuXxBmDEE Eu035VYTt2hauWr4Z3Ty9qLzXR/9myqeGyv6a/z7TF5kN9yqCl5dfZWqeNzofUNVfLu2 as/Bu5vn7AJ1xqnmiJXXdW5YOojzRyyvzqKIMGXst7E2T82M9gmS2MIEyKKhTtyxNx7E fpz1VK/9Ewsg1FvYttz/CKlYS/2MNJMu41eWCghtuyD35sKINMo69hRmH2WAnXZXmPSB cyUM6V6WQgLZHe5YKyzliPAh25hhVmVVDhDJpk19G0ZGpuN3SjdR8SQu+pX9Ki4ReKvS B3Tw== X-Forwarded-Encrypted: i=1; AJvYcCVjjDkuJgr2EvKDB9m4TRIKh1zbSXTnEoEw6UuEFtqWhApYW2di0bVGKOrj7M0F7Wf4NSB41r5jGqE82yQ3@vger.kernel.org, AJvYcCXDQwgSW9p6yvqfuckvCxR9HBZsn7sMKcdnKsIT3kplizndVymlnD1RYOt3FcuStLfudTo3pi+CxYZ0suc=@vger.kernel.org X-Gm-Message-State: AOJu0YyxkOmc60kEioO3nQfat+tiBjbhgphuTN6fQ9rJr7TOolR1r2s1 1ra1R0bt0cS1i4QDDVOPDw1OalLSYnuJrqG9MADfxQYoY0GBVEwRl43K X-Gm-Gg: ASbGncvW9jVtnqL24hIZrKwAENOFqfRm8/LpFeLn74jnSMm+FgYvY2AYqjbs0853BtG xvxxZdI66gcnLziHqAADzEMPaILDSq2vCqEQrGXp9Z1PPyCjm1Ak7GMbhGbeDycxZm1v8XXLgBH 9wnGDdAhhu/sEVzHbYknHbLqAmxd0jj2oW/6m7TkJT85MjG4kzh3HftcreKHA67zR1qeOeAybxD dQznGU3ogOVJXA595d8Rh6o+/BM0zNxSQidTent6UE+uuBXxR6s/CvX12Gk4py9gZMwB/KYj4Tx Fpyrr59ijbd8OIrEGYLKjCV9xyUHnrohD116vFpWWcx5lOn8mGrsRJXENHvkDPCJRIDiyj5bgaM lm0Vs5wOwZ4Ic9ZBfStzDc6O90miKEPob36mvb1a2ZVix72CaW3xSDSLlCnqZuCMtHPESJmWekr PNDxcWkTamX4XZLopA+g== X-Google-Smtp-Source: AGHT+IGdy+tOobQ6/cEnCP2LLYhWSoZQQ7yDGg9ljMT50J/2P7kmgHLbMeThCGXjBEyDpbxW4zO7HA== X-Received: by 2002:a5d:5886:0:b0:3d1:bb77:9119 with SMTP id ffacd0b85a97d-3d1e0a953a3mr6820630f8f.61.1756744993046; Mon, 01 Sep 2025 09:43:13 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:12 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 5/7] kfuzztest: add ReST documentation Date: Mon, 1 Sep 2025 16:42:10 +0000 Message-ID: <20250901164212.460229-6-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Add Documentation/dev-tools/kfuzztest.rst and reference it in the dev-tools index. Signed-off-by: Ethan Graham Acked-by: Alexander Potapenko --- v2: - Add documentation for kfuzztest-bridge tool introduced in patch 4. --- --- Documentation/dev-tools/index.rst | 1 + Documentation/dev-tools/kfuzztest.rst | 371 ++++++++++++++++++++++++++ 2 files changed, 372 insertions(+) create mode 100644 Documentation/dev-tools/kfuzztest.rst diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/in= dex.rst index 65c54b27a60b..00ccc4da003b 100644 --- a/Documentation/dev-tools/index.rst +++ b/Documentation/dev-tools/index.rst @@ -32,6 +32,7 @@ Documentation/process/debugging/index.rst kfence kselftest kunit/index + kfuzztest ktap checkuapi gpio-sloppy-logic-analyzer diff --git a/Documentation/dev-tools/kfuzztest.rst b/Documentation/dev-tool= s/kfuzztest.rst new file mode 100644 index 000000000000..aeaf433a320e --- /dev/null +++ b/Documentation/dev-tools/kfuzztest.rst @@ -0,0 +1,371 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. Copyright 2025 Google LLC + +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Kernel Fuzz Testing Framework (KFuzzTest) +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Overview +=3D=3D=3D=3D=3D=3D=3D=3D + +The Kernel Fuzz Testing Framework (KFuzzTest) is a framework designed to e= xpose +internal kernel functions to a userspace fuzzing engine. + +It is intended for testing stateless or low-state functions that are diffi= cult +to reach from the system call interface, such as routines involved in file +format parsing or complex data transformations. This provides a method for +in-situ fuzzing of kernel code without requiring that it be built as a sep= arate +userspace library or that its dependencies be stubbed out. + +The framework consists of four main components: + +1. An API, based on the ``FUZZ_TEST`` macro, for defining test targets + directly in the kernel tree. +2. A binary serialization format for passing complex, pointer-rich data + structures from userspace to the kernel. +3. A ``debugfs`` interface through which a userspace fuzzer submits + serialized test inputs. +4. Metadata embedded in dedicated ELF sections of the ``vmlinux`` binary = to + allow for the discovery of available fuzz targets by external tooling. + +.. warning:: + KFuzzTest is a debugging and testing tool. It exposes internal kernel + functions to userspace with minimal sanitization and is designed for + use in controlled test environments only. It must **NEVER** be enabled + in production kernels. + +Supported Architectures +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +KFuzzTest is currently only supported for x86_64. + +Usage +=3D=3D=3D=3D=3D + +To enable KFuzzTest, configure the kernel with:: + + CONFIG_KFUZZTEST=3Dy + +which depends on ``CONFIG_DEBUGFS`` for receiving userspace inputs, and +``CONFIG_DEBUG_KERNEL`` as an additional guardrail for preventing KFuzzTest +from finding its way into a production build accidentally. + +The KFuzzTest sample fuzz targets can be built in with +``CONFIG_SAMPLE_KFUZZTEST``. + +KFuzzTest currently only supports code that is built into the kernel, as t= he +core module's startup process discovers fuzz targets, constraints, and +annotations from a dedicated ELF section during startup. + +Declaring a KFuzzTest target +---------------------------- + +A fuzz target is defined directly in a .c file, typically alongside the fu= nction +being tested. This process involves three main parts: defining an input +structure, writing the test body using the ``FUZZ_TEST`` macro, and option= ally +adding metadata for the fuzzer. + +The following example illustrates how to create a fuzz target for a functi= on +``int process_data(const char *data, size_t len)``. + +.. code-block:: c + + /* + * 1. Define a struct to model the inputs for the function under test. + * Each field corresponds to an argument needed by the function. + */ + struct process_data_inputs { + const char *data; + size_t len; + }; + + /* + * 2. Define the fuzz target using the FUZZ_TEST macro. + * The first parameter is a unique name for the target. + * The second parameter is the input struct defined above. + */ + FUZZ_TEST(test_process_data, struct process_data_inputs) + { + /* + * Within this body, the 'arg' variable is a pointer to a + * fully initialized 'struct process_data_inputs'. + */ + + /* + * 3. (Optional) Add constraints to define preconditions. + * This check ensures 'arg->data' is not NULL. If the condition + * is not met, the test exits early. This also creates metadata + * to inform the fuzzer. + */ + KFUZZTEST_EXPECT_NOT_NULL(process_data_inputs, data); + + /* + * 4. (Optional) Add annotations to provide semantic hints. + * This annotation informs the fuzzer that the 'len' field + * is the length of the buffer pointed to by 'data'. + * Annotations do not add any runtime checks. + */ + KFUZZTEST_ANNOTATE_LEN(process_data_inputs, len, data); + + /* + * 5. Call the kernel function with the provided inputs. + * Memory errors like out-of-bounds accesses on 'arg->data' will + * be detected by KASAN or other memory error detection tools. + */ + process_data(arg->data, arg->len); + } + +KFuzzTest provides two families of macros to improve the quality of fuzzin= g: + +- ``KFUZZTEST_EXPECT_*``: These macros define constraints, which are + preconditions that must be true for the test to proceed. They are enforc= ed + with a runtime check in the kernel. If a check fails, the current test r= un is + aborted. This metadata helps the userspace fuzzer avoid generating inval= id + inputs. + +- ``KFUZZTEST_ANNOTATE_*``: These macros define annotations, which are pur= ely + semantic hints for the fuzzer. They do not add any runtime checks and ex= ist + only to help the fuzzer generate more intelligent and structurally corre= ct + inputs. For example, KFUZZTEST_ANNOTATE_LEN links a size field to a poin= ter + field, which is a common pattern in C APIs. + +Metadata +-------- + +Macros ``FUZZ_TEST``, `KFUZZTEST_EXPECT_*`` and ``KFUZZTEST_ANNOTATE_*`` e= mbed +metadata into several sections within the main ``.data`` section of the fi= nal +``vmlinux`` binary; ``.kfuzztest_target``, ``.kfuzztest_constraint`` and +``.kfuzztest_annotation`` respectively. + +This serves two purposes: + +1. The core module uses the ``.kfuzztest_target`` section at boot to disco= ver + every ``FUZZ_TEST`` instance and create its ``debugfs`` directory and + ``input`` file. +2. Userspace fuzzers can read this metadata from the ``vmlinux`` binary to + discover targets and learn about their rules and structure in order to + generate correct and effective inputs. + +The metadata in the ``.kfuzztest_*`` sections consists of arrays of fixed-= size C +structs (e.g., ``struct kfuzztest_target``). Fields within these structs t= hat +are pointers, such as ``name`` or ``arg_type_name``, contain addresses that +point to other locations in the ``vmlinux`` binary. A userspace tool that +parsing the ELF file must resolve these pointers to read the data that they +reference. For example, to get a target's name, a tool must: + +1. Read the ``struct kfuzztest_target`` from the ``.kfuzztest_target`` sec= tion. +2. Read the address in the ``.name`` field. +3. Use that address to locate and read null-terminated string from its pos= ition + elsewhere in the binary (e.g., ``.rodata``). + +Tooling Dependencies +-------------------- + +For userspace tools to parse the ``vmlinux`` binary and make use of emitted +KFuzzTest metadata, the kernel must be compiled with DWARF debug informati= on. +This is required for tools to understand the layout of C structs, resolve = type +information, and correctly interpret constraints and annotations. + +When using KFuzzTest with automated fuzzing tools, either +``CONFIG_DEBUG_INFO_DWARF4`` or ``CONFIG_DEBUG_INFO_DWARF5`` should be ena= bled. + +Input Format +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +KFuzzTest targets receive their inputs from userspace via a write to a ded= icated +debugfs ``/sys/kernel/debug/kfuzztest//input``. + +The data written to this file must be a single binary blob that follows a +specific serialization format. This format is designed to allow complex, +pointer-rich C structures to be represented in a flat buffer, requiring on= ly a +single kernel allocation and copy from userspace. + +An input is first prefixed by an 8-byte header containing a magic value in= the +first four bytes, defined as ``KFUZZTEST_HEADER_MAGIC`` in +```, and a version number in the subsequent four +bytes. + +Version 0 +--------- + +In version 0 (i.e., when the version number in the 8-byte header is equal = to 0), +the input format consists of three main parts laid out sequentially: a reg= ion +array, a relocation table, and the payload.:: + + +----------------+---------------------+-----------+----------------+ + | region array | relocation table | padding | payload | + +----------------+---------------------+-----------+----------------+ + +Region Array +^^^^^^^^^^^^ + +This component is a header that describes how the raw data in the Payload = is +partitioned into logical memory regions. It consists of a count of regions +followed by an array of ``struct reloc_region``, where each entry defines a +single region with its size and offset from the start of the payload. + +.. code-block:: c + + struct reloc_region { + uint32_t offset; + uint32_t size; + }; + + struct reloc_region_array { + uint32_t num_regions; + struct reloc_region regions[]; + }; + +By convention, region 0 represents the top-level input struct that is pass= ed +as the arg variable to the FUZZ_TEST body. Subsequent regions typically +represent data buffers pointed to by fields within that struct. Region arr= ay +entries must be ordered by offset ascending, and must not overlap with one +another. + +To satisfy C language alignment requirements and prevent potential hardware +faults, the memory address of each region's data must be correctly aligned= for +the type it represents. The framework allocates a base buffer that is suit= ably +aligned for any C type. Therefore, the userspace tool that generates the i= nput +is responsible for calculating each region's offset within the payload to = ensure +this alignment is maintained. + +Relocation Table +^^^^^^^^^^^^^^^^ + +The relocation table provides the instructions for the kernel to "hydrate"= the +payload by patching pointer fields. It contains an array of +``struct reloc_entry`` items. Each entry acts as a linking instruction, +specifying: + +- The location of a pointer that needs to be patched (identified by a regi= on + ID and an offset within that region). + +- The target region that the pointer should point to (identified by the + target's region ID) or ``KFUZZTEST_REGIONID_NULL`` if the pointer is ``N= ULL``. + +This table also specifies the amount of padding between its end and the st= art +of the payload, which should be at least 8 bytes. + +.. code-block:: c + + struct reloc_entry { + uint32_t region_id; + uint32_t region_offset; + uint32_t value; + }; + + struct reloc_table { + uint32_t num_entries; + uint32_t padding_size; + struct reloc_entry entries[]; + }; + +Payload +^^^^^^^ + +The payload contains the raw binary data for all regions, concatenated tog= ether +according to their specified offsets. + +- Alignment: The start of the payload must be aligned to the most restrict= ive + alignment requirement of all its constituent regions. The framework ensu= res + that each region within the payload is then placed at an offset that res= pects + its own type's alignment. + +- Padding and Poisoning: The space between the end of one region's data an= d the + beginning of the next must be sufficient for padding. In KASAN builds, + KFuzzTest poisons this unused padding, allowing for precise detection of + out-of-bounds memory accesses between adjacent buffers. This padding sho= uld + be at least ``KFUZZTEST_POISON_SIZE`` bytes as defined in + `include/linux/kfuzztest.h``. + +KFuzzTest Bridge Tool +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The kfuzztest-bridge program is a userspace utility that encodes a random = byte +stream into the structured binary format expected by a KFuzzTest harness. = It +allows users to describe the target's input structure textually, making it= easy +to perform smoke tests or connect harnesses to blob-based fuzzing engines. + +This tool is intended to be simple, both in usage and implementation. Its +structure and DSL are sufficient for simpler use-cases. For more advanced +coverage-guided fuzzing it is recommended to use syzkaller which implements +deeper support for KFuzzTest targets. + +Usage +----- + +The tool can be built with ``make tools/kfuzztest-bridge``. In the case of= libc +incompatibilities, the tool may have to be built on the target system. + +Example: + +.. code-block:: sh + + ./kfuzztest-bridge \ + "foo { u32 ptr[bar] }; bar { ptr[data] len[data, u64]}; data { arr= [u8, 42] };" \ + "my-fuzz-target" /dev/urandom + +The command takes three arguments + +1. A string describing the input structure (see `Textual Format`_ sub-sec= tion). +2. The name of the target test, which corresponds to its directory in + ``/sys/kernel/debug/kfuzztest/``. +3. A path to a file providing a stream of random data, such as + ``/dev/urandom``. + +The structure string in the example corresponds to the following C data +structures: + +.. code-block:: c + + struct foo { + u32 a; + struct bar *b; + }; + + struct bar { + struct data *d; + u64 data_len; /* Equals 42. */ + }; + + struct data { + char arr[42]; + }; + +Textual Format +-------------- + +The textual format is a human-readable representation of the region-based = binary +format used by KFuzzTest. It is described by the following grammar: + +.. code-block:: text + + schema ::=3D region ( ";" region )* [";"] + region ::=3D identifier "{" type+ "}" + type ::=3D primitive | pointer | array | length | string + primitive ::=3D "u8" | "u16" | "u32" | "u64" + pointer ::=3D "ptr" "[" identifier "]" + array ::=3D "arr" "[" primitive "," integer "]" + length ::=3D "len" "[" identifier "," primitive "]" + string ::=3D "str" "[" integer "]" + identifier ::=3D [a-zA-Z_][a-zA-Z1-9_]* + integer ::=3D [0-9]+ + +Pointers must reference a named region. To fuzz a raw buffer, the buffer m= ust be +defined in its own region, as shown below: + +.. code-block:: c + + struct my_struct { + char *buf; + size_t buflen; + }; + +This would correspond to the following textual description: + +.. code-block:: text + + my_struct { ptr[buf] len[buf, u64] }; buf { arr[u8, n] }; + +Where ``n`` is some integer value defining the size of the byte array insi= de of +the ``buf`` region. --=20 2.51.0.318.gd7df087d1a-goog From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wr1-f49.google.com (mail-wr1-f49.google.com [209.85.221.49]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id E26F8320A31; Mon, 1 Sep 2025 16:43:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744999; cv=none; b=aTIvt1jhI9AD9u4tjYzRvr4YfnGgylTG5Tm8XfZtK3G9dHZ1xzc3RiVFLu7/3y/ViTuUXsUa4FJR69O6vjHETVY+D4Xu7xrfkcf4N45AdN63tZdFSVDaJmnLRskXuBSWjSKG2RjjZurdJn1X5zZsYaTcfWQ3gSBeIwJw6vSXLG4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744999; c=relaxed/simple; bh=5G+472+LxBGUu9qceuoO7EbTjatKppK80VIx+iKXfLk=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=bWntlz6S3/NyDOnDIL/C+xEQIn4cIjoZbd4r5nYIGxDkpgAaWPxsKXDeUSSKeXpWOH6/4q5CJSUh2IrbIX4MtzTd4/5PqAgZ5koDeNcNA4H4hs7OwksUkewtVUfC55pnUAVtrVjSDz09FZjSJUijXglLt80KO8srkYbOCA6xXOk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=lmskYteQ; arc=none smtp.client-ip=209.85.221.49 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="lmskYteQ" Received: by mail-wr1-f49.google.com with SMTP id ffacd0b85a97d-3c68ac7e18aso2905584f8f.2; Mon, 01 Sep 2025 09:43:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744994; x=1757349794; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ApDGjF4qZlhoSmK2tdSzupo+2mRrDnKfGsOkf1zOwN4=; b=lmskYteQpwxvh+7VQdIzxKHxphQCnleZOGqEdYqSJbrxSu+W2gP2GY6qeRmOMYLZzt APYj7bi1QTkA7G5JFJDoLjGpHhZ+zbAQ0TXRYWOIKymzIZJ6AcMHvdEsmjZtCFhqxCXS qp+IKcEPDYdOSRbnpmn9hCy5bzACxEhFrl0pA3a/yg9GmX9fRi1kXSFNT+7QgoWe3Z/C R8I7BqtXLPwA+lOs22cQqb7GWGYA4e+CA2jLGcR56qYKq6w3xKnSOb9kWAVYq0Jg2GGx CekWnzMLWmuQm7iL962aZXn5XmeRBr49iZv5GcAOeDAPc+5moGDpxJoezOv2Cz5SSedh 2qng== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744994; x=1757349794; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ApDGjF4qZlhoSmK2tdSzupo+2mRrDnKfGsOkf1zOwN4=; b=gZnanYkqyio48CXzbLW3yr89IzfAOdGzFh1KqiG8aTxhSKiRIqe6f0jVkyV30M5AVo Vbm2otkc69HiXqhn5NedQVujtW7ylCkmjaJ/mGy7bv8wSc6aObPUZTygJYNHANmSvE5D hF9KwS5TLwj4DcN/JbwQo0+pLYWr984cZWgutN1CK1rDx6IoajnHcXLFgNmAg+3nKAfn y3JOwHscJ6DfGPepD0KXm82H4cvZSDE+OJyih0f5lWYUi57A4/96xvhivJmkqVe0zvQt wdW69ejBDg0nOQQgViNOMwVYP8649THBaxz1AFva8ebpD61PaJSp8bFDuuT5Kf22WRq1 1gxA== X-Forwarded-Encrypted: i=1; AJvYcCWPeP/1GbdehokBtZUYgDqxaoTGsFrDyj4MR/pkd8L4xIFyKGaeIt602nfc7XDejiW34HyL07I5vkxKs/o7@vger.kernel.org, AJvYcCXWFaKfXYyz84pBKXEw6UupU3fJJ0C48GYzePXWJkdJz0oOcDYbqHzsxdqNDs/n/mD4OpHBWLxhX25oajU=@vger.kernel.org X-Gm-Message-State: AOJu0YzWzsVPMF1dVT/VlPgi9ZDUtB5PrFTdrr+aOIS6A1j9PvQ16mG8 Cd0kMhqQf0ABwylN0W32QQFu9NyTIE3FuvfweDuWvCvwXN3qMurnTBXXc9Jghd1l6kf8TQ== X-Gm-Gg: ASbGnctrprO8wXOyJLvYU9qtqwsqAmDHuKaHClEfIMI7rflVd7vjzpcsOJL2YoJMpWf 2Il7hQlhaDeAYZc8p+TqolATLjhiAC/EXX2hlHu2t5/AWdLiHOUBcDWQeQL287uaht2sq8vGVgO mvvHMd06/AyY8GfiO1RCg1y+shkuRUMr1Uzh3AKObO0eRJYNDzrXlv6G7BOKymOiYyMcCin1b0u cAuzClQxOH0s7LCCWCeLFo7rR9LhSIwXnduxkkNUE6ck4oOyCDD/VK9wmjRpy0XSKe8+wWMXkKr p+mo0wPE7+E2sWvcKG+aq2VAkXpE+lbZG/ERbviIYsaCoVlKtd2YNN3gLrWxusSVBLnkoCUnfqm lyca6SDloQRIKiXXr/TPiqE9CPGC5kPX6EAc3hqsAXIllD2Ciq57T7RwFP3ZmHXI4i/zvDnjF7Y 5V4gNII6ZaqUPSCCDxPfO3/wn7G6io X-Google-Smtp-Source: AGHT+IGObzEWmAWMvVVCO+qu5XzxIJd7dvBXszVP90qakpw859cAfnGGaYfjxJR6FILuoiBJKV7+Qg== X-Received: by 2002:a05:6000:25ca:b0:3b7:9629:ac9e with SMTP id ffacd0b85a97d-3d1df34d63dmr5448037f8f.50.1756744993978; Mon, 01 Sep 2025 09:43:13 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:13 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 6/7] kfuzztest: add KFuzzTest sample fuzz targets Date: Mon, 1 Sep 2025 16:42:11 +0000 Message-ID: <20250901164212.460229-7-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Add two simple fuzz target samples to demonstrate the KFuzzTest API and provide basic self-tests for the framework. These examples showcase how a developer can define a fuzz target using the FUZZ_TEST(), constraint, and annotation macros, and serve as runtime sanity checks for the core logic. For example, they test that out-of-bounds memory accesses into poisoned padding regions are correctly detected in a KASAN build. These have been tested by writing syzkaller-generated inputs into their debugfs 'input' files and verifying that the correct KASAN reports were triggered. Signed-off-by: Ethan Graham Acked-by: Alexander Potapenko --- samples/Kconfig | 7 +++ samples/Makefile | 1 + samples/kfuzztest/Makefile | 3 ++ samples/kfuzztest/overflow_on_nested_buffer.c | 52 +++++++++++++++++++ samples/kfuzztest/underflow_on_buffer.c | 41 +++++++++++++++ 5 files changed, 104 insertions(+) create mode 100644 samples/kfuzztest/Makefile create mode 100644 samples/kfuzztest/overflow_on_nested_buffer.c create mode 100644 samples/kfuzztest/underflow_on_buffer.c diff --git a/samples/Kconfig b/samples/Kconfig index ffef99950206..4be51a21d010 100644 --- a/samples/Kconfig +++ b/samples/Kconfig @@ -321,6 +321,13 @@ config SAMPLE_HUNG_TASK if 2 or more processes read the same file concurrently, it will be detected by the hung_task watchdog. =20 +config SAMPLE_KFUZZTEST + bool "Build KFuzzTest sample targets" + depends on KFUZZTEST + help + Build KFuzzTest sample targets that serve as selftests for input + deserialization and inter-region redzone poisoning logic. + source "samples/rust/Kconfig" =20 source "samples/damon/Kconfig" diff --git a/samples/Makefile b/samples/Makefile index 07641e177bd8..3a0e7f744f44 100644 --- a/samples/Makefile +++ b/samples/Makefile @@ -44,4 +44,5 @@ obj-$(CONFIG_SAMPLE_DAMON_WSSE) +=3D damon/ obj-$(CONFIG_SAMPLE_DAMON_PRCL) +=3D damon/ obj-$(CONFIG_SAMPLE_DAMON_MTIER) +=3D damon/ obj-$(CONFIG_SAMPLE_HUNG_TASK) +=3D hung_task/ +obj-$(CONFIG_SAMPLE_KFUZZTEST) +=3D kfuzztest/ obj-$(CONFIG_SAMPLE_TSM_MR) +=3D tsm-mr/ diff --git a/samples/kfuzztest/Makefile b/samples/kfuzztest/Makefile new file mode 100644 index 000000000000..4f8709876c9e --- /dev/null +++ b/samples/kfuzztest/Makefile @@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0-only + +obj-$(CONFIG_SAMPLE_KFUZZTEST) +=3D overflow_on_nested_buffer.o underflow_= on_buffer.o diff --git a/samples/kfuzztest/overflow_on_nested_buffer.c b/samples/kfuzzt= est/overflow_on_nested_buffer.c new file mode 100644 index 000000000000..8b4bab1d6d4a --- /dev/null +++ b/samples/kfuzztest/overflow_on_nested_buffer.c @@ -0,0 +1,52 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * This file contains a KFuzzTest example target that ensures that a buffer + * overflow on a nested region triggers a KASAN OOB access report. + * + * Copyright 2025 Google LLC + */ +#include + +static void overflow_on_nested_buffer(const char *a, size_t a_len, const c= har *b, size_t b_len) +{ + size_t i; + pr_info("a =3D [%px, %px)", a, a + a_len); + pr_info("b =3D [%px, %px)", b, b + b_len); + + /* Ensure that all bytes in arg->b are accessible. */ + for (i =3D 0; i < b_len; i++) + READ_ONCE(b[i]); + /* + * Check that all bytes in arg->a are accessible, and provoke an OOB on + * the first byte to the right of the buffer which will trigger a KASAN + * report. + */ + for (i =3D 0; i <=3D a_len; i++) + READ_ONCE(a[i]); +} + +struct nested_buffers { + const char *a; + size_t a_len; + const char *b; + size_t b_len; +}; + +/** + * The KFuzzTest input format specifies that struct nested buffers should + * be expanded as: + * + * | a | b | pad[8] | *a | pad[8] | *b | + * + * where the padded regions are poisoned. We expect to trigger a KASAN rep= ort by + * overflowing one byte into the `a` buffer. + */ +FUZZ_TEST(test_overflow_on_nested_buffer, struct nested_buffers) +{ + KFUZZTEST_EXPECT_NOT_NULL(nested_buffers, a); + KFUZZTEST_EXPECT_NOT_NULL(nested_buffers, b); + KFUZZTEST_ANNOTATE_LEN(nested_buffers, a_len, a); + KFUZZTEST_ANNOTATE_LEN(nested_buffers, b_len, b); + + overflow_on_nested_buffer(arg->a, arg->a_len, arg->b, arg->b_len); +} diff --git a/samples/kfuzztest/underflow_on_buffer.c b/samples/kfuzztest/un= derflow_on_buffer.c new file mode 100644 index 000000000000..fbe214274037 --- /dev/null +++ b/samples/kfuzztest/underflow_on_buffer.c @@ -0,0 +1,41 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * This file contains a KFuzzTest example target that ensures that a buffer + * underflow on a region triggers a KASAN OOB access report. + * + * Copyright 2025 Google LLC + */ +#include + +static void underflow_on_buffer(char *buf, size_t buflen) +{ + size_t i; + + pr_info("buf =3D [%px, %px)", buf, buf + buflen); + + /* First ensure that all bytes in arg->b are accessible. */ + for (i =3D 0; i < buflen; i++) + READ_ONCE(buf[i]); + /* + * Provoke a buffer overflow on the first byte preceding b, triggering + * a KASAN report. + */ + READ_ONCE(*((char *)buf - 1)); +} + +struct some_buffer { + char *buf; + size_t buflen; +}; + +/** + * Tests that the region between struct some_buffer and the expanded *buf = field + * is correctly poisoned by accessing the first byte before *buf. + */ +FUZZ_TEST(test_underflow_on_buffer, struct some_buffer) +{ + KFUZZTEST_EXPECT_NOT_NULL(some_buffer, buf); + KFUZZTEST_ANNOTATE_LEN(some_buffer, buflen, buf); + + underflow_on_buffer(arg->buf, arg->buflen); +} --=20 2.51.0.318.gd7df087d1a-goog From nobody Fri Oct 3 11:15:08 2025 Received: from mail-wm1-f53.google.com (mail-wm1-f53.google.com [209.85.128.53]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 582AA2EF66A; Mon, 1 Sep 2025 16:43:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.53 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744999; cv=none; b=f47XLM9gFwG3Mc7cBemuQ4HiEMIpE52HYlrl+mUtPY/aypRLdTfB1ZNMGGemvMrixg3WONZi//M5laatCyBvAMQx6NpIG/3R5OT/MF4dcqvM26TmYtUeaaEuJnhpyIfEnJK+88cEkdI4pXMAsDvnMRV00TDtfyFlShk4a71yB0w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1756744999; c=relaxed/simple; bh=PjAcV8Pri16gdlPO+4S4c4wfzXPOKGnrjgBoxOT0UlQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=NdAQiO86rI3r4+26ovMeZNHSpsFv1mpqTs5SyvSnPQEnDQGuB1fjzZcTvXNqGM5BIbfvTmY5dhJTSya1aMWiqDrzFZsJpvrHbG6OOyBu3abOD127dUNgHX9sqSSnzFOQ37fpXv/rew4CQjHKcIUuRu853C5p5eN87iYKqQNcE1E= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=D7EHVIeT; arc=none smtp.client-ip=209.85.128.53 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="D7EHVIeT" Received: by mail-wm1-f53.google.com with SMTP id 5b1f17b1804b1-45b869d35a0so13401845e9.1; Mon, 01 Sep 2025 09:43:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1756744995; x=1757349795; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=IBvpSqbqbG4wFXeR5v1aPOZCpZfQ+jFjNgEJ1TDAElY=; b=D7EHVIeTHlDQRh9aWxX0Vz5Rckl7dj49d+nUdurLt2S7Dx+NIRL/KZCYXLxudLEfk9 crb6FT3ORw/RboGva4/8WdfE1ERRvT/GLKYiadOHu/hl7IZP6yf4KEiD1zKoeHHouy+5 BKSMkNKennHVLO1SUOhxV3ymyiht1BnTPQpduI8zx8zvufRZq4/ev8t5J/TAEmsPBPYK nOs7hYhrhN+XTZGCRzK5+kns7uP8ht6g9ZQs9wvgZQXc2xNldzT6/X4yyKo6nHaHfH+r BZlZhCIcyI2xBKI5VHcciMcLvGqavkpRoIm1FuHmYbSFUJnRB2rxzzls3EaogHM48BAH hScg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1756744995; x=1757349795; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=IBvpSqbqbG4wFXeR5v1aPOZCpZfQ+jFjNgEJ1TDAElY=; b=R+d171wBTfV+UFvpbV8xTkxmwl/VO1TXPERBfVE7yTvSEjE06S6v1xc58WYq8y3Nra hcC0s29XKYJAeUJ7AE12TjcsLHGmQlipnEJhUwtC0QUFOYiBUyGVcdmtl79fnP/blGhc ZBzU4nMuI9x4EkPVLBwau+g+ob2tXxPpxzSOeJ48o8oEtYjtNmVVTgStHFsHRbMg4IQI jxkX6o9U8S/K9zoCphl65nPe//aoeNo9pc4b/pNEL1nAmNlhN7yGtT+8phinOZz6cQ/k eEXt0tZpXPK2mHM2xTOMADwQGMBo3jrMrqSuuwQxuetdpMzI81mL5S8T8wL1R0LSDnDR caEw== X-Forwarded-Encrypted: i=1; AJvYcCUL5KVVftuxj89gf09Rvm5dhXE5Ps8+Yr0p37XyIWWrJ3y7Rph3X2lqPy2G1Cr8oUnV/DEW8JZMBQ0+3N7P@vger.kernel.org, AJvYcCVIk0SrZUc97tM69xrWwwee1SsapNzocHBYaTD6gdnIVlO0aAUe7GoojYioZLWAphLMLB7YzyQl5aprJfs=@vger.kernel.org X-Gm-Message-State: AOJu0Yy9IbJ++wSDRca9hue0lxFJ7jB7vFX0W6JZ9dhmRwDhSZfeNbYN qH2ALE9G+wTbXeebYAUiXv9oQUA3kpzIE35uPHigVQcMyPWUR4FkrEKM X-Gm-Gg: ASbGncsEkaTnu7lHMf1p9qmmB9XtxwXSIMNsQbYhva8cK5AuuP+q5Kc04lyhhIVI5q3 i7GFls+h8xgHfeBPHcgpACFZRYIep6HBm6ZwHfzV3U4Opn50Uh63W5L1GVAZDzRni0xkeaKNa8k J6uBSQj2m8N7/WiiFIS2l0R5g4Q+kEqZSF/1o/pH/JF7Y9uc9uOqimuxs/ZPJimBW5VV+DKoeYH tWK1BnZyJfW3cHI5yfRL0IG7zu2toZepbB4SbB026Opyjn4BXE5xTk8X6WOWtXrqHl7vngmKhNc Om7hOLe456kLV0HrhQqxZ1PhgOyZWojBxOKZBCQzzbwQRO5P87Dd6OFMY4qW0IWmPYe1AFys2WK 2HQqNHX4R9tjDJX1Vi1MGR0qt6UOb2FxmaBa04nzbQakat/ija+GF6jSYil+Oti+V8BgF5IfrhB kmwABaN0CWrJJxbWkAKdhqtBMb6az3 X-Google-Smtp-Source: AGHT+IFKo5JULDcPmqclDIOUfq+BI0sCVaxhFcUfvTCD5F0z7DntK34OPynj2UmgxgB5QgJJz7ystg== X-Received: by 2002:a05:6000:4210:b0:3d5:9efa:fbf2 with SMTP id ffacd0b85a97d-3d59efaff51mr3979157f8f.22.1756744994954; Mon, 01 Sep 2025 09:43:14 -0700 (PDT) Received: from xl-nested.c.googlers.com.com (140.225.77.34.bc.googleusercontent.com. [34.77.225.140]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3cf274dde69sm15955362f8f.14.2025.09.01.09.43.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Sep 2025 09:43:14 -0700 (PDT) From: Ethan Graham To: ethangraham@google.com, glider@google.com Cc: andreyknvl@gmail.com, brendan.higgins@linux.dev, davidgow@google.com, dvyukov@google.com, jannh@google.com, elver@google.com, rmoar@google.com, shuah@kernel.org, tarasmadan@google.com, kasan-dev@googlegroups.com, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, linux-mm@kvack.org, dhowells@redhat.com, lukas@wunner.de, ignat@cloudflare.com, herbert@gondor.apana.org.au, davem@davemloft.net, linux-crypto@vger.kernel.org Subject: [PATCH v2 RFC 7/7] crypto: implement KFuzzTest targets for PKCS7 and RSA parsing Date: Mon, 1 Sep 2025 16:42:12 +0000 Message-ID: <20250901164212.460229-8-ethan.w.s.graham@gmail.com> X-Mailer: git-send-email 2.51.0.318.gd7df087d1a-goog In-Reply-To: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> References: <20250901164212.460229-1-ethan.w.s.graham@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Ethan Graham Add KFuzzTest targets for pkcs7_parse_message, rsa_parse_pub_key, and rsa_parse_priv_key to serve as real-world examples of how the framework is = used. These functions are ideal candidates for KFuzzTest as they perform complex parsing of user-controlled data but are not directly exposed at the syscall boundary. This makes them difficult to exercise with traditional fuzzing to= ols and showcases the primary strength of the KFuzzTest framework: providing an interface to fuzz internal functions. The targets are defined within /lib/tests, alongside existing KUnit tests. Signed-off-by: Ethan Graham --- v2: - Move KFuzzTest targets outside of the source files into dedicated _kfuzz.c files under /crypto/asymmetric_keys/tests/ as suggested by Ignat Korchagin and Eric Biggers. --- --- crypto/asymmetric_keys/Kconfig | 15 ++++++++ crypto/asymmetric_keys/Makefile | 2 + crypto/asymmetric_keys/tests/Makefile | 2 + crypto/asymmetric_keys/tests/pkcs7_kfuzz.c | 22 +++++++++++ .../asymmetric_keys/tests/rsa_helper_kfuzz.c | 38 +++++++++++++++++++ 5 files changed, 79 insertions(+) create mode 100644 crypto/asymmetric_keys/tests/Makefile create mode 100644 crypto/asymmetric_keys/tests/pkcs7_kfuzz.c create mode 100644 crypto/asymmetric_keys/tests/rsa_helper_kfuzz.c diff --git a/crypto/asymmetric_keys/Kconfig b/crypto/asymmetric_keys/Kconfig index e1345b8f39f1..7a4c5eb18624 100644 --- a/crypto/asymmetric_keys/Kconfig +++ b/crypto/asymmetric_keys/Kconfig @@ -104,3 +104,18 @@ config FIPS_SIGNATURE_SELFTEST_ECDSA depends on CRYPTO_ECDSA=3Dy || CRYPTO_ECDSA=3DFIPS_SIGNATURE_SELFTEST =20 endif # ASYMMETRIC_KEY_TYPE + +config PKCS7_MESSAGE_PARSER_KFUZZ + bool "Build fuzz target for PKCS#7 parser" + depends on KFUZZTEST + depends on PKCS7_MESSAGE_PARSER + default y + help + Builds the KFuzzTest targets for PKCS#7. + +config RSA_HELPER_KFUZZ + bool "Build fuzz targets for RSA helpers" + depends on KFUZZTEST + default y + help + Builds the KFuzzTest targets for RSA helper functions. diff --git a/crypto/asymmetric_keys/Makefile b/crypto/asymmetric_keys/Makef= ile index bc65d3b98dcb..77b825aee6b2 100644 --- a/crypto/asymmetric_keys/Makefile +++ b/crypto/asymmetric_keys/Makefile @@ -67,6 +67,8 @@ obj-$(CONFIG_PKCS7_TEST_KEY) +=3D pkcs7_test_key.o pkcs7_test_key-y :=3D \ pkcs7_key_type.o =20 +obj-y +=3D tests/ + # # Signed PE binary-wrapped key handling # diff --git a/crypto/asymmetric_keys/tests/Makefile b/crypto/asymmetric_keys= /tests/Makefile new file mode 100644 index 000000000000..42a779c9042a --- /dev/null +++ b/crypto/asymmetric_keys/tests/Makefile @@ -0,0 +1,2 @@ +obj-$(CONFIG_PKCS7_MESSAGE_PARSER_KFUZZ) +=3D pkcs7_kfuzz.o +obj-$(CONFIG_RSA_HELPER_KFUZZ) +=3D rsa_helper_kfuzz.o diff --git a/crypto/asymmetric_keys/tests/pkcs7_kfuzz.c b/crypto/asymmetric= _keys/tests/pkcs7_kfuzz.c new file mode 100644 index 000000000000..84d0b0d8d0eb --- /dev/null +++ b/crypto/asymmetric_keys/tests/pkcs7_kfuzz.c @@ -0,0 +1,22 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * PKCS#7 parser KFuzzTest target + * + * Copyright 2025 Google LLC + */ +#include +#include + +struct pkcs7_parse_message_arg { + const void *data; + size_t datalen; +}; + +FUZZ_TEST(test_pkcs7_parse_message, struct pkcs7_parse_message_arg) +{ + KFUZZTEST_EXPECT_NOT_NULL(pkcs7_parse_message_arg, data); + KFUZZTEST_ANNOTATE_LEN(pkcs7_parse_message_arg, datalen, data); + KFUZZTEST_EXPECT_LE(pkcs7_parse_message_arg, datalen, 16 * PAGE_SIZE); + + pkcs7_parse_message(arg->data, arg->datalen); +} diff --git a/crypto/asymmetric_keys/tests/rsa_helper_kfuzz.c b/crypto/asymm= etric_keys/tests/rsa_helper_kfuzz.c new file mode 100644 index 000000000000..5877e54cb75a --- /dev/null +++ b/crypto/asymmetric_keys/tests/rsa_helper_kfuzz.c @@ -0,0 +1,38 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * RSA key extract helper KFuzzTest targets + * + * Copyright 2025 Google LLC + */ +#include +#include + +struct rsa_parse_pub_key_arg { + const void *key; + size_t key_len; +}; + +FUZZ_TEST(test_rsa_parse_pub_key, struct rsa_parse_pub_key_arg) +{ + KFUZZTEST_EXPECT_NOT_NULL(rsa_parse_pub_key_arg, key); + KFUZZTEST_ANNOTATE_LEN(rsa_parse_pub_key_arg, key_len, key); + KFUZZTEST_EXPECT_LE(rsa_parse_pub_key_arg, key_len, 16 * PAGE_SIZE); + + struct rsa_key out; + rsa_parse_pub_key(&out, arg->key, arg->key_len); +} + +struct rsa_parse_priv_key_arg { + const void *key; + size_t key_len; +}; + +FUZZ_TEST(test_rsa_parse_priv_key, struct rsa_parse_priv_key_arg) +{ + KFUZZTEST_EXPECT_NOT_NULL(rsa_parse_priv_key_arg, key); + KFUZZTEST_ANNOTATE_LEN(rsa_parse_priv_key_arg, key_len, key); + KFUZZTEST_EXPECT_LE(rsa_parse_priv_key_arg, key_len, 16 * PAGE_SIZE); + + struct rsa_key out; + rsa_parse_priv_key(&out, arg->key, arg->key_len); +} --=20 2.51.0.318.gd7df087d1a-goog