Received-SPF: pass (google.com: domain of linux-kernel+bounces-78169-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Fri, 23 Feb 2024 10:41:21 +0000
From: Lee Jones <lee@kernel.org>
To: David Laight <David.Laight@aculab.com>
Cc: 'Justin Stitt' <justinstitt@google.com>,
	Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
	Dwaipayan Ray <dwaipayanray1@gmail.com>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"linux-hardening@vger.kernel.org" <linux-hardening@vger.kernel.org>,
	Kees Cook <keescook@chromium.org>,
	Finn Thain <fthain@linux-m68k.org>
Subject: Re: [PATCH v2] checkpatch: add check for snprintf to scnprintf
Message-ID: <20240223104121.GQ10170@google.com>
References: <20240221-snprintf-checkpatch-v2-1-9baeb59dae30@google.com>
 <dd2b4ac483b54a41aff11a04b6906fd6@AcuMS.aculab.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <dd2b4ac483b54a41aff11a04b6906fd6@AcuMS.aculab.com>

On Thu, 22 Feb 2024, David Laight wrote:

> From: Justin Stitt
> > Sent: 21 February 2024 22:12
> > 
> > I am going to quote Lee Jones who has been doing some snprintf ->
> > scnprintf refactorings:
> > 
> > "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."
> 
> While generally true, there are places that really do want to
> detect (and error) overflow.
> That isn't possible with scnprintf().
> 
> I'm not sure what the solution is though.
> Having a function that returns a negative value on overflow is also
> likely to get misused.
> seq_printf() (or whatever it is called) may let you check,
> but it is hardly a cheap wrapper and a bit of a PITA to use.

I agree.

spprinf() was my favorite solution, but it seems that the lib string
people don't like to accept new functionality, even if it's a clear
improvement over the currently available solutions.

[0] https://lore.kernel.org/all/20240130160953.766676-1-lee@kernel.org/

-- 
Lee Jones [李琼斯]