tracing: use strscpy() to instead of strncpy()
PATCH 1/1 tracing: use strscpy() to instead of strncpy()
From: Xu Panda <[email protected]>
The implementation of strscpy() is more robust and safer. That's now the recommended way to copy NUL-terminated strings.
--- kernel/trace/trace_events_synth.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
kernel/trace/trace_events_synth.c +1 -2
@@ -195,8 +195,7 @@ static int synth_field_string_size(char *type)if (len ==0 )return 0 ;/* variable-length string */ -strncpy (buf, start, len); - buf[len] ='\0' ; +strscpy (buf, start, len +1 ); err =kstrtouint (buf,0 , &size);if (err)
Signature · 1 line
2.15.2
Quoted 4 lines · On Mon, 9 Jan 2023 19:39:21 +0800 (CST) <[email protected]> wrote:
From: Xu Panda <[email protected]>
The implementation of
strscpy()is more robust and safer. That's now the recommended way to copy NUL-terminated strings.
This looks good to me.
Thank you,
Quoted 23 lines
Signed-off-by Xu Panda <[email protected]>Signed-off-by Yang Yang <[email protected]>--- kernel/trace/trace_events_synth.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)kernel/trace/trace_events_synth.c +1
-2@@ -195,8 +195,7 @@ static int synth_field_string_size(char *type)if (len ==0 )return 0 ;/* variable-length string */ -strncpy (buf, start, len); - buf[len] ='\0' ; +strscpy (buf, start, len +1 ); err =kstrtouint (buf,0 , &size);if (err)Signature · 1 line
2.15.2
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>
Quoted 4 lines · On Mon, 9 Jan 2023 19:39:21 +0800 (CST) <[email protected]> wrote:
From: Xu Panda <[email protected]>
The implementation of
strscpy()is more robust and safer. That's now the recommended way to copy NUL-terminated strings.
But the string being copied is *not* NUL-terminated! And this change causes a bug.
This is the 3rd patch I've seen that blindly converts strncpy() to strscpy() and causes a bug in doing so. Not very safe if you ask me.
Quoted 12 lines
Signed-off-by Xu Panda <[email protected]>Signed-off-by Yang Yang <[email protected]>--- kernel/trace/trace_events_synth.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)kernel/trace/trace_events_synth.c +0
-0
kernel/trace/trace_events_synth.c static int synth_field_string_size(char *type) · line 201
Quoted 9 lines
kernel/trace/trace_events_synth.c +1
-2@@ -195,8 +195,7 @@ static int synth_field_string_size(char *type)if (len ==0 )return 0 ;/* variable-length string */ -strncpy (buf, start, len); - buf[len] ='\0' ; +strscpy (buf, start, len +1 ); err =kstrtouint (buf,0 , &size);if (err)
Here's the code being affected:
static int synth_field_string_size(char *type)
{
char buf[4], *end, *start;
unsigned int len;
int size, err;
start = strstr(type, "char[");
if (start == NULL)
return -EINVAL;
start += sizeof("char[") - 1;
end = strchr(type, ']');
if (!end || end < start || type + strlen(type) > end + 1)
return -EINVAL;
len = end - start;
if (len > 3)
return -EINVAL;
if (len == 0)
return 0; /* variable-length string */
strncpy(buf, start, len);
buf[len] = '\0';And you are replacing the above two lines with just:
strscpy(buf, start, len + 1);
If you noticed, the string being placed into buf is:
"char[123]"
Where we want to copy that "123" into buf.
strscpy() expects the source to be nul terminated, or it will return -E2BIG.
So the above will *always* return -E2BIG *and* not end buf[] with '\0' as if strscpy() returns -E2BIG, then buf[] is not guaranteed to be NUL-terminated.
NACK!
-- Steve
Hi Steve,
Can we revisit this patch? see below.
Quoted 73 lines · Steven Rostedt
Quoted 4 lines · On Mon, 9 Jan 2023 19:39:21 +0800 (CST) <[email protected]> wrote:
From: Xu Panda <[email protected]>
The implementation of
strscpy()is more robust and safer. That's now the recommended way to copy NUL-terminated strings.But the string being copied is *not* NUL-terminated! And this change causes a bug.
This is the 3rd patch I've seen that blindly converts
strncpy()tostrscpy()and causes a bug in doing so. Not very safe if you ask me.Quoted 12 lines
Signed-off-by Xu Panda <[email protected]>Signed-off-by Yang Yang <[email protected]>--- kernel/trace/trace_events_synth.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)kernel/trace/trace_events_synth.c +0
-0kernel/trace/trace_events_synth.c static int synth_field_string_size(char *type) · line 201
Quoted 9 lines
kernel/trace/trace_events_synth.c +1
-2@@ -195,8 +195,7 @@ static int synth_field_string_size(char *type)if (len ==0 )return 0 ;/* variable-length string */ -strncpy (buf, start, len); - buf[len] ='\0' ; +strscpy (buf, start, len +1 ); err =kstrtouint (buf,0 , &size);if (err)Here's the code being affected:
static int
synth_field_string_size(char *type){ char buf[4], *end, *start; unsigned int len; int size, err; start = strstr(type, "char["); if (start == NULL) return -EINVAL; start += sizeof("char[") - 1; end = strchr(type, ']'); if (!end || end < start || type + strlen(type) > end + 1) return -EINVAL; len = end - start; if (len > 3) return -EINVAL; if (len == 0) return 0; /* variable-length string */ strncpy(buf, start, len); buf[len] = '\0';And you are replacing the above two lines with just:
strscpy(buf, start, len + 1);If you noticed, the string being placed into buf is:
"char[123]"
Quoted 7 lines
Where we want to copy that "123" into buf.
strscpy()expects the source to be nul terminated, or it will return-E2BIG.So the above will *always* return
-E2BIG*and* not end buf[] with '\0' as ifstrscpy()returns-E2BIG, then buf[] is not guaranteed to be NUL-terminated.
@buf should still be NUL-terminated while returning -E2BIG in this instance. For context, here's the implementation of strscpy():
...
/* Hit buffer length without finding a NUL; force NUL-termination. */ if (res)
dest[res-1] = '\0';
return -E2BIG;
... and the only other spot where we can return E2BIG is way earlier in the function where we check the count.
if (count == 0 || WARN_ON_ONCE(count > INT_MAX))
return -E2BIG;
So it seems we should be NUL-terminating @buf in all cases, considering count is greater than 0 and certainly not larger than INT_MAX. And, with the len + 1 we shouldn't be seeing any data loss either.
Quoted 5 lines
NACK!
-- Steve
I'm keen on replacing this instance of strncpy towards the goal of [1]. If we don't want to use strscpy() I think memcpy() is another viable alternative (of course leaving the manual NUL-byte assignment as-is).
[1]: https://github.com/KSPP/linux/issues/90
Thanks
Justin
Hi Steven,
I was about to submit the same patch when I found this one from 2023.
Quoted 3 lines · Steven Rostedt
So the above will *always* return
-E2BIG*and* not end buf[] with '\0' as ifstrscpy()returns-E2BIG, then buf[] is not guaranteed to be NUL-terminated.
The return value is not used and the strscpy() documentation in linux/string.h says:
"The destination @dst buffer is always NUL terminated, unless it's zero- sized." and "Preferred to strncpy() since it always returns a valid string, ..."
Has strscpy() changed since 2023 or could this patch be revisited? I saw that Justin also made an effort in September 2024 [1] to revisit it and to remove the deprecated strncpy() here.
Quoted 3 lines
NACK!
-- Steve
Thanks,
Thorsten
[1] https://lore.kernel.org/r/yhv3rzg6vhgwage27cyvg72t4vwf5x3tdtj3zjipryzvz3u55x@c33q753uxyi3/
Cc: [email protected]