diff mbox series

[net-next] net/rds: Replace deprecated strncpy() with strscpy_pad()

Message ID 20250219224730.73093-2-thorsten.blum@linux.dev (mailing list archive)
State New
Headers show
Series [net-next] net/rds: Replace deprecated strncpy() with strscpy_pad() | expand

Commit Message

Thorsten Blum Feb. 19, 2025, 10:47 p.m. UTC
strncpy() is deprecated for NUL-terminated destination buffers. Use
strscpy_pad() instead and remove the manual NUL-termination.

Compile-tested only.

Link: https://github.com/KSPP/linux/issues/90
Cc: linux-hardening@vger.kernel.org
Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
---
 net/rds/stats.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Kees Cook Feb. 20, 2025, 2:57 a.m. UTC | #1
On Wed, Feb 19, 2025 at 11:47:31PM +0100, Thorsten Blum wrote:
> strncpy() is deprecated for NUL-terminated destination buffers. Use
> strscpy_pad() instead and remove the manual NUL-termination.

When doing these conversions, please describe two aspects of
conversions:

- Why is it safe to be NUL terminated
- Why is it safe to be/not-be NUL-padded

In this case, the latter needs examination. Looking at how ctr is used,
it is memcpy()ed later, which means this string MUST be NUL padded or it
will leak stack memory contents.

So, please use strscpy_pad() here. :)

-Kees

> 
> Compile-tested only.
> 
> Link: https://github.com/KSPP/linux/issues/90
> Cc: linux-hardening@vger.kernel.org
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
>  net/rds/stats.c | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/net/rds/stats.c b/net/rds/stats.c
> index 9e87da43c004..cb2e3d2cdf73 100644
> --- a/net/rds/stats.c
> +++ b/net/rds/stats.c
> @@ -89,8 +89,7 @@ void rds_stats_info_copy(struct rds_info_iterator *iter,
>  
>  	for (i = 0; i < nr; i++) {
>  		BUG_ON(strlen(names[i]) >= sizeof(ctr.name));
> -		strncpy(ctr.name, names[i], sizeof(ctr.name) - 1);
> -		ctr.name[sizeof(ctr.name) - 1] = '\0';
> +		strscpy_pad(ctr.name, names[i]);
>  		ctr.value = values[i];
>  
>  		rds_info_copy(iter, &ctr, sizeof(ctr));
> -- 
> 2.48.1
> 
>
Thorsten Blum Feb. 20, 2025, 7:04 a.m. UTC | #2
On 20. Feb 2025, at 03:57, Kees Cook wrote:
> On Wed, Feb 19, 2025 at 11:47:31PM +0100, Thorsten Blum wrote:
>> strncpy() is deprecated for NUL-terminated destination buffers. Use
>> strscpy_pad() instead and remove the manual NUL-termination.
> 
> When doing these conversions, please describe two aspects of
> conversions:
> 
> - Why is it safe to be NUL terminated
> - Why is it safe to be/not-be NUL-padded
> 
> In this case, the latter needs examination. Looking at how ctr is used,
> it is memcpy()ed later, which means this string MUST be NUL padded or it
> will leak stack memory contents.
> 
> So, please use strscpy_pad() here. :)

I am using strscpy_pad() here already because of the NUL-padding.

Did you just miss that?

Thanks,
Thorsten
Kees Cook Feb. 20, 2025, 8:54 a.m. UTC | #3
On February 19, 2025 11:04:18 PM PST, Thorsten Blum <thorsten.blum@linux.dev> wrote:
>On 20. Feb 2025, at 03:57, Kees Cook wrote:
>> On Wed, Feb 19, 2025 at 11:47:31PM +0100, Thorsten Blum wrote:
>>> strncpy() is deprecated for NUL-terminated destination buffers. Use
>>> strscpy_pad() instead and remove the manual NUL-termination.
>> 
>> When doing these conversions, please describe two aspects of
>> conversions:
>> 
>> - Why is it safe to be NUL terminated
>> - Why is it safe to be/not-be NUL-padded
>> 
>> In this case, the latter needs examination. Looking at how ctr is used,
>> it is memcpy()ed later, which means this string MUST be NUL padded or it
>> will leak stack memory contents.
>> 
>> So, please use strscpy_pad() here. :)
>
>I am using strscpy_pad() here already because of the NUL-padding.
>
>Did you just miss that?

Well that's embarrassing. Yes, I must need stronger glasses. *sigh* Apologies for the noise!

Reviewed-by: Kees Cook <kees@kernel.org>
Allison Henderson Feb. 20, 2025, 6:07 p.m. UTC | #4
On Wed, 2025-02-19 at 23:47 +0100, Thorsten Blum wrote:
> strncpy() is deprecated for NUL-terminated destination buffers. Use
> strscpy_pad() instead and remove the manual NUL-termination.
> 
> Compile-tested only.
> 
> Link: https://urldefense.com/v3/__https://github.com/KSPP/linux/issues/90__;!!ACWV5N9M2RV99hQ!MpqMAmj6IIyu7Vj4ddfEGJlJY4rVrJL_g8etOQsHC7pdjZO77P7aOqJe8_JTFwBzZ6tciUDrbb2CjXWJMjdEMJGtpoeBfHU8qw$ 
> Cc: linux-hardening@vger.kernel.org
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
>  net/rds/stats.c | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/net/rds/stats.c b/net/rds/stats.c
> index 9e87da43c004..cb2e3d2cdf73 100644
> --- a/net/rds/stats.c
> +++ b/net/rds/stats.c
> @@ -89,8 +89,7 @@ void rds_stats_info_copy(struct rds_info_iterator *iter,
>  
>  	for (i = 0; i < nr; i++) {
>  		BUG_ON(strlen(names[i]) >= sizeof(ctr.name));
> -		strncpy(ctr.name, names[i], sizeof(ctr.name) - 1);
> -		ctr.name[sizeof(ctr.name) - 1] = '\0';
> +		strscpy_pad(ctr.name, names[i]);
>  		ctr.value = values[i];
>  
Looks ok to me.  Thanks Thorsten!
Reviewed-by: Allison Henderson <allison.henderson@oracle.com>

>  		rds_info_copy(iter, &ctr, sizeof(ctr));
Allison Henderson Feb. 20, 2025, 6:49 p.m. UTC | #5
On Thu, 2025-02-20 at 11:07 -0700, Allison Henderson wrote:
> On Wed, 2025-02-19 at 23:47 +0100, Thorsten Blum wrote:
> > strncpy() is deprecated for NUL-terminated destination buffers. Use
> > strscpy_pad() instead and remove the manual NUL-termination.
> > 
> > Compile-tested only.

I went ahead and tested this for you, and it looks fine.  So, you can go ahead and remove the "Compiled-tested only" and
add:
Tested-by: Allison Henderson <allison.henderson@oracle.com>

Thank you!
Allison
> > 
> > Link: https://urldefense.com/v3/__https://github.com/KSPP/linux/issues/90__;!!ACWV5N9M2RV99hQ!MpqMAmj6IIyu7Vj4ddfEGJlJY4rVrJL_g8etOQsHC7pdjZO77P7aOqJe8_JTFwBzZ6tciUDrbb2CjXWJMjdEMJGtpoeBfHU8qw$ 
> > Cc: linux-hardening@vger.kernel.org
> > Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> > ---
> >  net/rds/stats.c | 3 +--
> >  1 file changed, 1 insertion(+), 2 deletions(-)
> > 
> > diff --git a/net/rds/stats.c b/net/rds/stats.c
> > index 9e87da43c004..cb2e3d2cdf73 100644
> > --- a/net/rds/stats.c
> > +++ b/net/rds/stats.c
> > @@ -89,8 +89,7 @@ void rds_stats_info_copy(struct rds_info_iterator *iter,
> >  
> >  	for (i = 0; i < nr; i++) {
> >  		BUG_ON(strlen(names[i]) >= sizeof(ctr.name));
> > -		strncpy(ctr.name, names[i], sizeof(ctr.name) - 1);
> > -		ctr.name[sizeof(ctr.name) - 1] = '\0';
> > +		strscpy_pad(ctr.name, names[i]);
> >  		ctr.value = values[i];
> >  
> Looks ok to me.  Thanks Thorsten!
> Reviewed-by: Allison Henderson <allison.henderson@oracle.com>
> 
> >  		rds_info_copy(iter, &ctr, sizeof(ctr));
>
patchwork-bot+netdevbpf@kernel.org Feb. 22, 2025, 12:10 a.m. UTC | #6
Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Wed, 19 Feb 2025 23:47:31 +0100 you wrote:
> strncpy() is deprecated for NUL-terminated destination buffers. Use
> strscpy_pad() instead and remove the manual NUL-termination.
> 
> Compile-tested only.
> 
> Link: https://github.com/KSPP/linux/issues/90
> Cc: linux-hardening@vger.kernel.org
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> 
> [...]

Here is the summary with links:
  - [net-next] net/rds: Replace deprecated strncpy() with strscpy_pad()
    https://git.kernel.org/netdev/net-next/c/c451715d78e3

You are awesome, thank you!
diff mbox series

Patch

diff --git a/net/rds/stats.c b/net/rds/stats.c
index 9e87da43c004..cb2e3d2cdf73 100644
--- a/net/rds/stats.c
+++ b/net/rds/stats.c
@@ -89,8 +89,7 @@  void rds_stats_info_copy(struct rds_info_iterator *iter,
 
 	for (i = 0; i < nr; i++) {
 		BUG_ON(strlen(names[i]) >= sizeof(ctr.name));
-		strncpy(ctr.name, names[i], sizeof(ctr.name) - 1);
-		ctr.name[sizeof(ctr.name) - 1] = '\0';
+		strscpy_pad(ctr.name, names[i]);
 		ctr.value = values[i];
 
 		rds_info_copy(iter, &ctr, sizeof(ctr));