Re: [PATCH 1/1] lib/vsprintf: Implement ssprintf() to catch truncated strings

[Lee Jones]

On Tue, 30 Jan 2024, Rasmus Villemoes wrote:

> On 30/01/2024 16.07, Lee Jones wrote:
> > On Mon, 29 Jan 2024, Lee Jones wrote:
> > 
> >> On Mon, 29 Jan 2024, David Laight wrote:
> >>
> >>> ...
> >>>>> 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.
> >>>>
> >>>> snprintf() does this and has been proven to cause buffer-overflows.
> >>>> There have been multiple articles authored describing why using
> >>>> snprintf() is not generally a good idea for the masses including the 2
> >>>> linked in the commit message:
> >>>
> >>> snprintf() returns the number of bytes that would have been output [1].
> >>> I'm not suggesting that, or not terminating the buffer.
> >>> Just returning the length including the '\0' (unless length was zero).
> >>> This still lets the code check for overflow but isn't going to
> >>> generate a pointer outside the buffer if used to update a pointer.
> >>
> >> I see.  Well I'm not married to my solution.  However, I am convinced
> >> that the 2 solutions currently offered can be improved upon.  If you or
> >> anyone else has a better solution, I'd be more than happy to implement
> >> and switch to it.
> >>
> >> Let me have a think about the solution you suggest and get back to you.
> > 
> > Okay, I've written a bunch of simple test cases and results are
> > positive.  It seems to achieve my aim whilst minimising any potential
> > pitfalls.
> > 
> >  - Success returns Bytes actually written - no functional change
> >  - Overflow returns the size of the buffer - which makes the result
> >    a) testable for overflow
> >    b) non-catastrophic if accidentally used to manipulate later sizes
> 
> You are describing scnprintf(), which almost does exactly that. The last
> thing we need is another interface with almost identical semantics.

It does, which is why when I first centred my efforts on this task the
plan was to simply switch to it.  However, as I described in the commit
message:

  "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."

A great deal of callers want to know if the string they attempted to
form was successful.  A malformed string would lead to oddities in the
best cases and various device/probing/matching failures in the worst.

> >     int size = 10;
> >     char buf[size];
> >     char *b = buf;
> > 
> >     ret = spprintf(b, size, "1234");
> >     size -= ret;
> >     b += ret;
> >     // ret = 4  size = 6  buf = "1234\0"
> > 
> >     ret = spprintf(b, size, "5678");
> >     size -= ret;
> >     b += ret;
> >     // ret = 4  size = 2  buf = "12345678\0"
> > 
> >     ret = spprintf(b, size, "9***");
> >     size -= ret;
> >     b += ret;
> >     // ret = 2  size = 0  buf = "123456789\0"
> 
> So here scnprint() would have returned 1, leaving size at 1. scnprintf()
> has the invariant that, for non-zero size, the return value is strictly
> less than that size, so when passed a size of 1, all subsequent calls
> return 0 (corresponding to the fact that all it could do was to write
> the '\0' terminator).
> 
> This pattern already exists, and is really the reason scnprint exists.
> Yes, scnprintf() cannot distinguish overflow from
> it-just-exactly-fitted. Maybe it would have been better to make it work
> like this, but I don't think there's a real use

There are real use-cases.  They are what brought me here.

> and we do have
> seq_buf() if one really wants an interface that can build a string
> piece-meal while keeping track of whether it ever caused overflow.

seq_buf_*() looks okay, but it's petty heavy requiring what looks like
the buffers to be initialised with an API call before use.  We're
looking for something more light weight.

scnprint() had clear safety centric improvements over snprintf() and
spprintf() adds an additional layer of return value checking on top of
that.

I'm not sure I understand the resistance to something which is needed
and has clear benefits over what presently exists just for the sake of a
few lines of code.  I'd be on board if it were change for the sake of
change, but the added flexibility and ease of use is evident.

-- 
Lee Jones [李琼斯]