Skip to contentSkip to conversation

wifi: cfg80211: replace strlcpy() with strscpy()

PATCH In review Azeem Shaikh 2 participants 5 messages Jun 14, 2023

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 wifi: cfg80211: replace strlcpy() with strscpy()

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to remove strlcpy() completely [2], replace strlcpy() here with strscpy().

Direct replacement is safe here since WIPHY_ASSIGN is only used by TRACE macros and the return values are ignored.

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

---
v1: https://lore.kernel.org/all/[email protected]/
v2: https://lore.kernel.org/all/[email protected]/

Changes from v1 and v2 - updated patch title.

 net/wireless/trace.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
net/wireless/trace.h +1 -1
index 716a1fa70069..a00da3ebfed5 100644
@@ -22,7 +22,7 @@
 
 #define MAXNAME		32
 #define WIPHY_ENTRY	__array(char, wiphy_name, 32)
-#define WIPHY_ASSIGN	strlcpy(__entry->wiphy_name, wiphy_name(wiphy), MAXNAME)
+#define WIPHY_ASSIGN	strscpy(__entry->wiphy_name, wiphy_name(wiphy), MAXNAME)
 #define WIPHY_PR_FMT	"%s"
 #define WIPHY_PR_ARG	__entry->wiphy_name
 
Signature · 1 line
2.41.0.162.gfafddb0af9-goog
#1 lore raw
Quoted 10 lines · Azeem Shaikh

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to remove strlcpy() completely [2], replace strlcpy() here with strscpy().

Direct replacement is safe here since WIPHY_ASSIGN is only used by TRACE macros and the return values are ignored.

Quoted 7 lines

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

---
v1: https://lore.kernel.org/all/[email protected]/
v2: https://lore.kernel.org/all/[email protected]/

In the change log (after the "---" line) you should also describe what changes you made, more info in the wiki below. In this case it's clear as the patch is simple but please keep this in mind for future patches.

No need to resend because of this.

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#2 lore raw
Quoted 21 lines · Kalle Valo
Quoted 10 lines · Azeem Shaikh

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to remove strlcpy() completely [2], replace strlcpy() here with strscpy().

Direct replacement is safe here since WIPHY_ASSIGN is only used by TRACE macros and the return values are ignored.

Quoted 7 lines

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

---
v1: https://lore.kernel.org/all/[email protected]/
v2: https://lore.kernel.org/all/[email protected]/

Quoted 6 lines

In the change log (after the "---" line) you should also describe what changes you made, more info in the wiki below. In this case it's clear as the patch is simple but please keep this in mind for future patches.

No need to resend because of this.

Thanks Kalle. I did have the below line in my changelog. For future patches, do you mean that changelog descriptions need to be more specific than this? For example - updated title from "x" -> "y"?

Quoted 1 line

Changes from v1 and v2 - updated patch title.

#3 lore raw
Quoted 27 lines · Azeem Shaikh
Quoted 25 lines · Kalle Valo
Quoted 10 lines · Azeem Shaikh

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to remove strlcpy() completely [2], replace strlcpy() here with strscpy().

Direct replacement is safe here since WIPHY_ASSIGN is only used by TRACE macros and the return values are ignored.

Quoted 7 lines

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

---
v1: https://lore.kernel.org/all/[email protected]/
v2: https://lore.kernel.org/all/[email protected]/

In the change log (after the "---" line) you should also describe what changes you made, more info in the wiki below. In this case it's clear as the patch is simple but please keep this in mind for future patches.

Quoted 8 lines
Quoted 2 lines

No need to resend because of this.

Thanks Kalle. I did have the below line in my changelog. For future patches, do you mean that changelog descriptions need to be more specific than this? For example - updated title from "x" -> "y"?

Quoted 1 line

Changes from v1 and v2 - updated patch title.

Ah, I missed that because the format was not what we usually use. I recommend something like this:

v3:

* add bar

v2:

* https://
* fix foo

v1:

* https://

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#4 lore raw
Quoted 46 lines · Kalle Valo
Quoted 27 lines · Azeem Shaikh
Quoted 25 lines · Kalle Valo
Quoted 10 lines · Azeem Shaikh

strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to remove strlcpy() completely [2], replace strlcpy() here with strscpy().

Direct replacement is safe here since WIPHY_ASSIGN is only used by TRACE macros and the return values are ignored.

Quoted 7 lines

[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89

---
v1: https://lore.kernel.org/all/[email protected]/
v2: https://lore.kernel.org/all/[email protected]/

In the change log (after the "---" line) you should also describe what changes you made, more info in the wiki below. In this case it's clear as the patch is simple but please keep this in mind for future patches.

Quoted 8 lines
Quoted 2 lines

No need to resend because of this.

Thanks Kalle. I did have the below line in my changelog. For future patches, do you mean that changelog descriptions need to be more specific than this? For example - updated title from "x" -> "y"?

Quoted 1 line

Changes from v1 and v2 - updated patch title.

Ah, I missed that because the format was not what we usually use. I recommend something like this:

v3:

* add bar

Quoted 9 lines

v2:

* https://
* fix foo

v1:

* https://

Got it, thanks a lot!