mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: David Laight <David.Laight@ACULAB.COM>
To: 'Lee Jones' <lee@kernel.org>,
	Rasmus Villemoes <linux@rasmusvillemoes.dk>
Cc: "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"linux-hardening@vger.kernel.org"
	<linux-hardening@vger.kernel.org>,
	"Andrew Morton" <akpm@linux-foundation.org>,
	Petr Mladek <pmladek@suse.com>,
	"Steven Rostedt" <rostedt@goodmis.org>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Sergey Senozhatsky <senozhatsky@chromium.org>,
	Crutcher Dunnavant <crutcher+kernel@datastacks.com>,
	Juergen Quade <quade@hsnr.de>
Subject: RE: [PATCH 1/1] lib/vsprintf: Implement ssprintf() to catch truncated strings
Date: Sat, 27 Jan 2024 14:32:23 +0000	[thread overview]
Message-ID: <54e518b6dd9647c1add38b706eccbb4b@AcuMS.aculab.com> (raw)
In-Reply-To: <20240125103624.GC74950@google.com>

From: Lee Jones
> Sent: 25 January 2024 10:36
> On Thu, 25 Jan 2024, Rasmus Villemoes wrote:
> 
> > On 25/01/2024 09.39, Lee Jones wrote:
> > > There is an ongoing effort to replace the use of {v}snprintf() variants
> > > with safer alternatives - for a more in depth view, see Jon's write-up
> > > on LWN [0] and/or Alex's on the Kernel Self Protection Project [1].
> > >
> > > Whist executing the task, it quickly became apparent that the initial
> > > thought of simply s/snprintf/scnprintf/ wasn't going to be adequate for
> > > a number of cases.  Specifically ones where the caller needs to know
> > > whether the given string ends up being truncated.  This is where
> > > ssprintf() [based on similar semantics of strscpy()] comes in, since it
> > > takes the best parts of both of the aforementioned variants.  It has the
> > > testability of truncation of snprintf() and returns the number of Bytes
> > > *actually* written, similar to scnprintf(), making it a very programmer
> > > friendly alternative.
> > >
> > > Here's some examples to show the differences:
> > >
> > >   Success: No truncation - all 9 Bytes successfully written to the buffer
> > >
> > >     ret = snprintf (buf, 10, "%s", "123456789");  // ret = 9
> > >     ret = scnprintf(buf, 10, "%s", "123456789");  // ret = 9
> > >     ret = ssprintf (buf, 10, "%s", "123456789");  // ret = 9
> > >
> > >   Failure: Truncation - only 9 of 10 Bytes written; '-' is truncated
> > >
> > >     ret = snprintf (buf, 10, "%s", "123456789-"); // ret = 10
> > >
> > >       Reports: "10 Bytes would have been written if buf was large enough"
> > >       Issue: Programmers need to know/remember to check ret against "10"
> >
> > Yeah, so I'm not at all sure we need yet-another-wrapper with
> > yet-another-hard-to-read-prefix when people can just RTFM and learn how
> > to check for truncation or whatnot. But if you do this:
> 
> As wonderful as it would be for people to "just RTFM", we're seeing a
> large number of cases where this isn't happening.  Providing a more
> programmer friendly way is thought, by people way smarter than me, to be
> a solid means to solve this issue.  Please also see Kees Cook's related
> work to remove strlcpy() use.

My worry is that people will believe the length and forget that
it might be an error code.

So you replace one set of errors (truncated data), with another
worse set (eg write before start of buffer).

I'm sure that the safest return for 'truncated' is the buffer length.
The a series of statements like:
	buf += xxx(buf, buf_end - buf, .....);
can all be called with a single overflow check at the end.

Forget the check, and the length just contains a trailing '\0'
which might cause confusion but isn't going to immediately
break the world.

	David

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK
Registration No: 1397386 (Wales)

  reply	other threads:[~2024-01-27 14:32 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-25  8:39 Lee Jones
2024-01-25  9:04 ` Rasmus Villemoes
2024-01-25 10:36   ` Lee Jones
2024-01-27 14:32     ` David Laight [this message]
2024-01-29  9:24       ` Lee Jones
2024-01-29  9:39         ` David Laight
2024-01-29  9:52           ` Lee Jones
2024-01-30 15:07             ` Lee Jones
2024-01-30 15:18               ` Rasmus Villemoes
2024-01-30 15:53                 ` Lee Jones
2024-02-08 16:24                   ` Petr Mladek
2024-02-08 17:05                     ` Lee Jones
2024-01-30 21:55                 ` Kees Cook
2024-01-31  8:36                   ` Lee Jones
2024-01-29  9:27 Lee Jones
2024-01-29  9:31 ` Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=54e518b6dd9647c1add38b706eccbb4b@AcuMS.aculab.com \
    --to=david.laight@aculab.com \
    --cc=akpm@linux-foundation.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=crutcher+kernel@datastacks.com \
    --cc=lee@kernel.org \
    --cc=linux-hardening@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@rasmusvillemoes.dk \
    --cc=pmladek@suse.com \
    --cc=quade@hsnr.de \
    --cc=rostedt@goodmis.org \
    --cc=senozhatsky@chromium.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®