netdev - [PATCH 3/3] checkpatch: add ethtool

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20231025-ethtool_puts_impl-v1-3-6a53a93d3b72@google.com>
Date: Wed, 25 Oct 2023 23:40:34 +0000
From: Justin Stitt <justinstitt@...gle.com>
To: "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, 
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, Shay Agroskin <shayagr@...zon.com>, 
	Arthur Kiyanovski <akiyano@...zon.com>, David Arinzon <darinzon@...zon.com>, Noam Dagan <ndagan@...zon.com>, 
	Saeed Bishara <saeedb@...zon.com>, Rasesh Mody <rmody@...vell.com>, 
	Sudarsana Kalluru <skalluru@...vell.com>, GR-Linux-NIC-Dev@...vell.com, 
	Dimitris Michailidis <dmichail@...gible.com>, Yisen Zhuang <yisen.zhuang@...wei.com>, 
	Salil Mehta <salil.mehta@...wei.com>, Jesse Brandeburg <jesse.brandeburg@...el.com>, 
	Tony Nguyen <anthony.l.nguyen@...el.com>, Louis Peens <louis.peens@...igine.com>, 
	Shannon Nelson <shannon.nelson@....com>, Brett Creeley <brett.creeley@....com>, drivers@...sando.io, 
	"K. Y. Srinivasan" <kys@...rosoft.com>, Haiyang Zhang <haiyangz@...rosoft.com>, Wei Liu <wei.liu@...nel.org>, 
	Dexuan Cui <decui@...rosoft.com>, Ronak Doshi <doshir@...are.com>, 
	VMware PV-Drivers Reviewers <pv-drivers@...are.com>, Andy Whitcroft <apw@...onical.com>, Joe Perches <joe@...ches.com>, 
	Dwaipayan Ray <dwaipayanray1@...il.com>, Lukas Bulwahn <lukas.bulwahn@...il.com>
Cc: linux-kernel@...r.kernel.org, netdev@...r.kernel.org, 
	Nick Desaulniers <ndesaulniers@...gle.com>, Nathan Chancellor <nathan@...nel.org>, 
	Kees Cook <keescook@...omium.org>, intel-wired-lan@...ts.osuosl.org, 
	oss-drivers@...igine.com, linux-hyperv@...r.kernel.org, 
	Justin Stitt <justinstitt@...gle.com>
Subject: [PATCH 3/3] checkpatch: add ethtool_sprintf rules

Add some warnings for using ethtool_sprintf() where a simple
ethtool_puts() would suffice.

The two cases are:

1) Use ethtool_sprintf() with just two arguments:
|       ethtool_sprintf(&data, driver[i].name);
or
2) Use ethtool_sprintf() with a standalone "%s" fmt string:
|       ethtool_sprintf(&data, "%s", driver[i].name);

The former may cause -Wformat-security warnings while the latter is just
not preferred. Both are safely in the category of warnings, not errors.

Signed-off-by: Justin Stitt <justinstitt@...gle.com>
---
 scripts/checkpatch.pl | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 7d16f863edf1..1ba9ce778746 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -7020,6 +7020,19 @@ sub process {
 			     "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90\n" . $herecurr);
 		}
 
+# ethtool_sprintf uses that should likely be ethtool_puts
+		if (   $line =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/   ) {
+			WARN("ETHTOOL_SPRINTF",
+			     "Prefer ethtool_puts over ethtool_sprintf with only two arguments" . $herecurr);
+		}
+
+		# use $rawline because $line loses %s via sanitization and thus we can't match against it.
+		if (   $rawline =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*\"\%s\"\s*,\s*$FuncArg\s*\)/   ) {
+			WARN("ETHTOOL_SPRINTF2",
+			     "Prefer ethtool_puts over ethtool_sprintf with standalone \"%s\" specifier" . $herecurr);
+		}
+
+
 # typecasts on min/max could be min_t/max_t
 		if ($perl_version_ok &&
 		    defined $stat &&

-- 
2.42.0.758.gaed0368e0e-goog