netdev - Re: [Intel-wired-lan] [PATCH net-next v5 2/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 for Android: free password hash cracker in your pocket
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date: Thu, 7 Dec 2023 08:39:15 +0100
From: Przemek Kitszel <przemyslaw.kitszel@...el.com>
To: <justinstitt@...gle.com>, "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>, Hauke Mehrtens <hauke@...ke-m.de>, "Andrew Lunn"
	<andrew@...n.ch>, Florian Fainelli <f.fainelli@...il.com>, "Vladimir Oltean"
	<olteanv@...il.com>, Arınç ÜNAL
	<arinc.unal@...nc9.com>, Daniel Golle <daniel@...rotopia.org>, Landen Chao
	<Landen.Chao@...iatek.com>, DENG Qingfang <dqfext@...il.com>, Sean Wang
	<sean.wang@...iatek.com>, Matthias Brugger <matthias.bgg@...il.com>,
	AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>, "Linus
 Walleij" <linus.walleij@...aro.org>, Alvin Šipraga
	<alsi@...g-olufsen.dk>, Wei Fang <wei.fang@....com>, Shenwei Wang
	<shenwei.wang@....com>, Clark Wang <xiaoning.wang@....com>, NXP Linux Team
	<linux-imx@....com>, Lars Povlsen <lars.povlsen@...rochip.com>, "Steen
 Hegelund" <Steen.Hegelund@...rochip.com>, Daniel Machon
	<daniel.machon@...rochip.com>, <UNGLinuxDriver@...rochip.com>, Jiawen Wu
	<jiawenwu@...stnetic.com>, Mengyuan Lou <mengyuanlou@...-swift.com>, "Heiner
 Kallweit" <hkallweit1@...il.com>, Russell King <linux@...linux.org.uk>,
	"Alexei Starovoitov" <ast@...nel.org>, Daniel Borkmann
	<daniel@...earbox.net>, "Jesper Dangaard Brouer" <hawk@...nel.org>, John
 Fastabend <john.fastabend@...il.com>
CC: <linux-hyperv@...r.kernel.org>, Kees Cook <keescook@...omium.org>,
	<netdev@...r.kernel.org>, Nick Desaulniers <ndesaulniers@...gle.com>,
	<linux-kernel@...r.kernel.org>, Nathan Chancellor <nathan@...nel.org>,
	<oss-drivers@...igine.com>, <intel-wired-lan@...ts.osuosl.org>,
	<linux-mediatek@...ts.infradead.org>, <bpf@...r.kernel.org>,
	<linux-arm-kernel@...ts.infradead.org>
Subject: Re: [Intel-wired-lan] [PATCH net-next v5 2/3] checkpatch: add
 ethtool_sprintf rules

On 12/7/23 00:16, justinstitt@...gle.com wrote:
> 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 | 19 +++++++++++++++++++
>   1 file changed, 19 insertions(+)
> 

Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@...el.com>

> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 25fdb7fda112..6924731110d8 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -7011,6 +7011,25 @@ 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*\)/) {
> +			if (WARN("PREFER_ETHTOOL_PUTS",
> +				 "Prefer ethtool_puts over ethtool_sprintf with only two arguments\n" . $herecurr) &&
> +			    $fix) {
> +				$fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*($FuncArg)/ethtool_puts($1, $7)/;
> +			}
> +		}
> +
> +		# 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*\)/) {
> +			if (WARN("PREFER_ETHTOOL_PUTS",
> +				 "Prefer ethtool_puts over ethtool_sprintf with standalone \"%s\" specifier\n" . $herecurr) &&
> +			    $fix) {
> +				$fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*"\%s"\s*,\s*($FuncArg)/ethtool_puts($1, $7)/;

(not related to the patch)
without deeper digging it was completely unclear why it is $7 for the
"second" capture group, turns out that FuncArg contains parens and other
vars with parens :~

> +			}
> +		}
> +
> +
>   # typecasts on min/max could be min_t/max_t
>   		if ($perl_version_ok &&
>   		    defined $stat &&
>