Received-SPF: pass (google.com: domain of linux-kernel+bounces-163302-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <aacd7c3a5ad5bb4df71ec5dd107ef12b6ebf4079.camel@perches.com>
Subject: Re: [PATCH v6] checkpatch: add check for snprintf to scnprintf
From: Joe Perches <joe@perches.com>
To: Kees Cook <keescook@chromium.org>, Justin Stitt <justinstitt@google.com>
Cc: Andy Whitcroft <apw@canonical.com>, Dwaipayan Ray
 <dwaipayanray1@gmail.com>,  Lukas Bulwahn <lukas.bulwahn@gmail.com>,
 linux-kernel@vger.kernel.org, Lee Jones <lee@kernel.org>, 
 linux-hardening@vger.kernel.org, Finn Thain <fthain@linux-m68k.org>
Date: Mon, 29 Apr 2024 20:21:49 -0700
In-Reply-To: <202404291249.078D924@keescook>
References: <20240429-snprintf-checkpatch-v6-1-354c62c88290@google.com>
	 <202404291249.078D924@keescook>
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 Mon, 2024-04-29 at 12:49 -0700, Kees Cook wrote:
> On Mon, Apr 29, 2024 at 06:39:28PM +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 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>
>=20
> Thanks!
>=20
> Reviewed-by: Kees Cook <keescook@chromium.org>
>=20

$ git grep -P '\b((v|)snprintf)\s*\(' | wc -l
7745
$ git grep -P '(?:return\s+|=3D\s*)\b((v|)snprintf)\s*\(' | wc -l
1626

Given there are ~5000 uses of these that don't care
whether or not it's snprintf or scnprintf, I think this
is not great.

I'd much rather make sure the return value of the call
is used before suggesting an alternative.

$ git grep  -P '\b((v|)snprintf)\s*\(.*PAGE_SIZE' | wc -l
515

And about 1/3 of these snprintf calls are for sysfs style
output that ideally would be converted to sysfs_emit or
sysfs_emit_at instead.