Received-SPF: pass (google.com: domain of linux-kernel+bounces-75750-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Message-ID: <bccc704fc78b362bbc57a79eb240219f5ec1548e.camel@perches.com>
Subject: Re: [PATCH v2] checkpatch: add check for snprintf to scnprintf
From: Joe Perches <joe@perches.com>
To: Justin Stitt <justinstitt@google.com>, Andy Whitcroft
 <apw@canonical.com>,  Dwaipayan Ray <dwaipayanray1@gmail.com>, Lukas
 Bulwahn <lukas.bulwahn@gmail.com>
Cc: linux-kernel@vger.kernel.org, Lee Jones <lee@kernel.org>, 
 linux-hardening@vger.kernel.org, Kees Cook <keescook@chromium.org>, Finn
 Thain <fthain@linux-m68k.org>
Date: Wed, 21 Feb 2024 17:05:30 -0800
In-Reply-To: <20240221-snprintf-checkpatch-v2-1-9baeb59dae30@google.com>
References: <20240221-snprintf-checkpatch-v2-1-9baeb59dae30@google.com>
Content-Type: text/plain; charset="ISO-8859-1"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.48.4 (3.48.4-1.fc38) 
Precedence: bulk
MIME-Version: 1.0

On Wed, 2024-02-21 at 22:11 +0000, Justin Stitt wrote:
> I am going to quote Lee Jones who has been doing some snprintf ->
> scnprintf refactorings:
>=20
> "There is a general misunderstanding amongst engineers that
> {v}snprintf() returns the length of the data *actually* encoded into the
> destination array.  However, as per the C99 standard {v}snprintf()
> really returns the length of the data that *would have been* written if
> there were enough space for it.  This misunderstanding has led to
> buffer-overruns in the past.  It's generally considered safer to use the
> {v}scnprintf() variants in their place (or even sprintf() in simple
> cases).  So let's do that."
>=20
> To help prevent new instances of snprintf() from popping up, let's add a
> check to checkpatch.pl.
>=20
> Suggested-by: Finn Thain <fthain@linux-m68k.org>
> Signed-off-by: Justin Stitt <justinstitt@google.com>
> ---
> Changes in v2:
> - Had a vim moment and deleted a character before sending the patch.
> - Replaced the character :)
> - Link to v1: https://lore.kernel.org/r/20240221-snprintf-checkpatch-v1-1=
-3ac5025b5961@google.com
> ---
> From a discussion here [1].
>=20
> [1]: https://lore.kernel.org/all/0f9c95f9-2c14-eee6-7faf-635880edcea4@lin=
ux-m68k.org/

> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -7012,6 +7012,12 @@ sub process {
>  			     "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see:=
 https://github.com/KSPP/linux/issues/90\n" . $herecurr);
>  		}
> =20
> +# snprintf uses that should likely be {v}scnprintf
> +		if ($line =3D~ /\bsnprintf\s*\(\s*/) {
> +				WARN("SNPRINTF",
> +				     "Prefer scnprintf over snprintf\n" . $herecurr);

There really should be some sort of reference link here
similar to the one above this.

Also, I rather doubt _all_ of these should be changed just
for churn's sake.

Maybe add a test for some return value use like

		if (defined($stat) &&
		    $stat =3D~ /$Lval\s*=3D\s*snprintf\s*\(/) {
			etc...

Maybe offer to --fix it too.