Skip to contentSkip to conversation

staging: rtl8192e: prefer strscpy over strncpy

PATCH In review Michael Straube 3 participants 6 messages Aug 5, 2023 – Sep 5, 2023 Staging

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 staging: rtl8192e: prefer strscpy over strncpy

Replace strncpy with strscpy in two places where the destination buffer should be NUL-terminated. Found by checkpatch.

WARNING: Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90

---
 drivers/staging/rtl8192e/rtllib_softmac.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/staging/rtl8192e/rtllib_softmac.c +2 -2
index 0e52b207942d..bd19d6a2ce41 100644
@@ -1564,7 +1564,7 @@ inline void rtllib_softmac_new_net(struct rtllib_device *ieee,
 				    (!strncmp(ieee->current_network.ssid,
 				    net->hidden_ssid, net->hidden_ssid_len));
 			if (net->hidden_ssid_len > 0) {
-				strncpy(net->ssid, net->hidden_ssid,
+				strscpy(net->ssid, net->hidden_ssid,
 					net->hidden_ssid_len);
 				net->ssid_len = net->hidden_ssid_len;
 				ssidbroad = 1;
@@ -2431,7 +2431,7 @@ static void rtllib_start_master_bss(struct rtllib_device *ieee)
 	ieee->assoc_id = 1;
 
 	if (ieee->current_network.ssid_len == 0) {
-		strncpy(ieee->current_network.ssid,
+		strscpy(ieee->current_network.ssid,
 			RTLLIB_DEFAULT_TX_ESSID,
 			IW_ESSID_MAX_SIZE);
 
Signature · 1 line
2.41.0
maintainer
#1 lore raw
Quoted 4 lines · Michael Straube

Replace strncpy with strscpy in two places where the destination buffer should be NUL-terminated. Found by checkpatch.

WARNING: Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90

If a global search/replace could be done, it would have happend a long time ago.

How was this tested? The functions work differently, are you sure there is no change in functionality here?

thanks,

greg k-h

#2 lore raw
Quoted 4 lines · Greg KH
Quoted 3 lines · Michael Straube

Replace strncpy with strscpy in two places where the destination buffer should be NUL-terminated. Found by checkpatch.

Quoted 8 lines
Quoted 1 line

WARNING: Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90

If a global search/replace could be done, it would have happend a long time ago.

How was this tested? The functions work differently, are you sure there is no change in functionality here?

It was only compile tested. To me it looked as it does not change functionality, but looking a bit deeper at it I'm not sure anymore. So, we should leave it as is.

thank you
Michael

#3 lore raw
Quoted 10 lines · Michael Straube
Quoted 9 lines · Greg KH
Quoted 4 lines · Michael Straube

Replace strncpy with strscpy in two places where the destination buffer should be NUL-terminated. Found by checkpatch.

WARNING: Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90

If a global search/replace could be done, it would have happend a long time ago.

Quoted 7 lines
Quoted 3 lines

How was this tested? The functions work differently, are you sure there is no change in functionality here?

It was only compile tested. To me it looked as it does not change functionality, but looking a bit deeper at it I'm not sure anymore. So, we should leave it as is.

So there are three main differences between strncpy() and strcpy().

1) The return.
2) strncpy() will always write net->hidden_ssid_len bytes. If the string to copy is smaller than net->hidden_ssid_len bytes it will fill the rest with zeroes. This can be important for preventing information leaks.
3) strscpy() will always add a NUL terminator where strncpy() just truncates a too long string without adding a terminator.

We want #3. We don't care about #1. The only thing to check is #2.

regards,
dan carpenter

#4 lore raw
Quoted 29 lines · Dan Carpenter
Quoted 10 lines · Michael Straube
Quoted 9 lines · Greg KH
Quoted 4 lines · Michael Straube

Replace strncpy with strscpy in two places where the destination buffer should be NUL-terminated. Found by checkpatch.

WARNING: Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90

If a global search/replace could be done, it would have happend a long time ago.

Quoted 7 lines
Quoted 3 lines

How was this tested? The functions work differently, are you sure there is no change in functionality here?

It was only compile tested. To me it looked as it does not change functionality, but looking a bit deeper at it I'm not sure anymore. So, we should leave it as is.

So there are three main differences between strncpy() and strcpy().

1) The return.
2) strncpy() will always write net->hidden_ssid_len bytes. If the string to copy is smaller than net->hidden_ssid_len bytes it will fill the rest with zeroes. This can be important for preventing information leaks.
3) strscpy() will always add a NUL terminator where strncpy() just truncates a too long string without adding a terminator.

Quoted 5 lines

We want #3. We don't care about #1. The only thing to check is #2.

regards,
dan carpenter

Thank you Dan,

so in this case we should/could replace strncpy with strscpy_pad, correct?

regards,
Michael

#5 lore raw
Quoted 32 lines · Michael Straube
Quoted 31 lines · Dan Carpenter
Quoted 10 lines · Michael Straube
Quoted 9 lines · Greg KH
Quoted 4 lines · Michael Straube

Replace strncpy with strscpy in two places where the destination buffer should be NUL-terminated. Found by checkpatch.

WARNING: Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90

If a global search/replace could be done, it would have happend a long time ago.

Quoted 7 lines
Quoted 3 lines

How was this tested? The functions work differently, are you sure there is no change in functionality here?

It was only compile tested. To me it looked as it does not change functionality, but looking a bit deeper at it I'm not sure anymore. So, we should leave it as is.

So there are three main differences between strncpy() and strcpy().

1) The return.
2) strncpy() will always write net->hidden_ssid_len bytes. If the string to copy is smaller than net->hidden_ssid_len bytes it will fill the rest with zeroes. This can be important for preventing information leaks.
3) strscpy() will always add a NUL terminator where strncpy() just truncates a too long string without adding a terminator.

We want #3. We don't care about #1. The only thing to check is #2.

Quoted 8 lines
Quoted 3 lines

regards,
dan carpenter

Thank you Dan,

so in this case we should/could replace strncpy with strscpy_pad, correct?

I'm pretty sure that strscpy() was correct. It requires some analysis in how this is initialized and/or used.

Don't just automatically use strscpy_pad() to try avoid doing the analysis. ;)

regards,
dan carpenter