Received-SPF: pass (google.com: domain of linux-kernel+bounces-141599-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Message-ID: <1a4554d39229c790c98bebb213bc9f2423cd32de.camel@perches.com>
Subject: Re: [PATCH v4] checkpatch: add check for snprintf to scnprintf
From: Joe Perches <joe@perches.com>
To: Christophe JAILLET <christophe.jaillet@wanadoo.fr>, 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: Thu, 11 Apr 2024 13:56:27 -0700
In-Reply-To: <48d593c1-c706-4af3-aacf-d1329a8b0d4b@wanadoo.fr>
References: <20240408-snprintf-checkpatch-v4-1-8697c96ac94b@google.com>
	 <48d593c1-c706-4af3-aacf-d1329a8b0d4b@wanadoo.fr>
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 Thu, 2024-04-11 at 22:01 +0200, Christophe JAILLET wrote:
> Le 08/04/2024 =E0 22:53, Justin Stitt a =E9crit=A0:
> > 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 th=
e
> > 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 th=
e
> > {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 v4:
> > - also check for vsnprintf variant (thanks Bill)
> > - Link to v3: https://lore.kernel.org/r/20240315-snprintf-checkpatch-v3=
-1-a451e7664306@google.com
> >=20
> > Changes in v3:
> > - fix indentation
> > - add reference link (https://github.com/KSPP/linux/issues/105) (thanks=
 Joe)
> > - Link to v2: https://lore.kernel.org/r/20240221-snprintf-checkpatch-v2=
-1-9baeb59dae30@google.com
> >=20
> > 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@l=
inux-m68k.org/
> > ---
> >   scripts/checkpatch.pl | 6 ++++++
> >   1 file changed, 6 insertions(+)
> >=20
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > index 9c4c4a61bc83..a0fd681ea837 100755
> > --- a/scripts/checkpatch.pl
> > +++ b/scripts/checkpatch.pl
> > @@ -7012,6 +7012,12 @@ sub process {
> >   			     "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - s=
ee: https://github.com/KSPP/linux/issues/90\n" . $herecurr);
> >   		}
> >  =20
> > +# {v}snprintf uses that should likely be {v}scnprintf
> > +		if ($line =3D~ /\b(v|)snprintf\s*\(\s*/) {
>=20
> Hi,
>=20
> for my understanding, what is the purpose of the 2nd "\s*"?
> IMHO, it could be just removed.

It could.

# {v}snprintf uses that should likely be {v}scnprintf
		if ($line =3D~ /\b((v?)snprintf)\s*\(/) {
			WARN("SNPRINTF",
			     "Prefer ${2}scnprintf over $1 - see: https://github.com/KSPP/linux/=
issues/105\n" . $herecurr);
		}


Though I also think it's better to use lore rather than github