Skip to contentSkip to conversation

scsi: ufs: Leave space for '\0' in utf8 desc string

PATCH Applied Daniel Mentz 4 participants 5 messages Oct 17, 2023 – Oct 25, 2023

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

PATCH 1/1 scsi: ufs: Leave space for '\0' in utf8 desc string

utf16s_to_utf8s does not NULL terminate the output string. For us to be able to add a NULL character when utf16s_to_utf8s returns, we need to make sure that there is space for such NULL character at the end of the output buffer. We can achieve this by passing an output buffer size to utf16s_to_utf8s that is one character less than what we allocated.

Other call sites of utf16s_to_utf8s appear to be using the same technique where they artificially reduce the buffer size by one to leave space for a NULL character or line feed character.

Fixes 4b828fe156a6 ("scsi: ufs: revamp string descriptor reading")
---
 drivers/ufs/core/ufshcd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/ufs/core/ufshcd.c +1 -1
index 8382e8cfa414..5767642982c1 100644
@@ -3632,7 +3632,7 @@ int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index,
 		 */
 		ret = utf16s_to_utf8s(uc_str->uc,
 				      uc_str->len - QUERY_DESC_HDR_SIZE,
-				      UTF16_BIG_ENDIAN, str, ascii_len);
+				      UTF16_BIG_ENDIAN, str, ascii_len - 1);
 
 		/* replace non-printable or non-ASCII characters with spaces */
 		for (i = 0; i < ret; i++)
Signature · 1 line
2.42.0.655.g421f12c284-goog
reviewer Reviewed-by on v1 1/1
#1 lore raw
Quoted 11 lines

utf16s_to_utf8s does not NULL terminate the output string. For us to be able to add a NULL character when utf16s_to_utf8s returns, we need to make sure that there is space for such NULL character at the end of the output buffer. We can achieve this by passing an output buffer size to utf16s_to_utf8s that is one character less than what we allocated.

Other call sites of utf16s_to_utf8s appear to be using the same technique where they artificially reduce the buffer size by one to leave space for a NULL character or line feed character.

Fixes 4b828fe156a6 ("scsi: ufs: revamp string descriptor reading")

I think this code goes back to commit b573d484e4ff (scsi: ufs: add support to read device and string descriptors)

Quoted 25 lines
---
 drivers/ufs/core/ufshcd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/ufs/core/ufshcd.c index renamed from drivers/ufs/core/ufshcd.c +0 -0

8382e8cfa414..5767642982c1 100644

drivers/ufs/core/ufshcd.c +2 -2
@@ -3632,7 +3632,7 @@ int ufshcd_read_string_desc(struct ufs_hba *hba,
 u8 desc_index,
                 */
                ret = utf16s_to_utf8s(uc_str->uc,
                                      uc_str->len - QUERY_DESC_HDR_SIZE,
-                                     UTF16_BIG_ENDIAN, str, ascii_len);
+                                     UTF16_BIG_ENDIAN, str, ascii_len -
+ 1);
 
                /* replace non-printable or non-ASCII characters with spaces */
                for (i = 0; i < ret; i++)
--

2.42.0.655.g421f12c284-goog

#2 lore raw
Quoted 2 lines · Avri Altman
Quoted 1 line
Fixes 4b828fe156a6 ("scsi: ufs: revamp string descriptor reading")

I think this code goes back to commit b573d484e4ff (scsi: ufs: add support to read device and string descriptors)

Hmm ... it seems to me that there was no buffer overflow in commit b573d484e4ff but that the buffer overflow was introduced by commit 4b828fe156a6?

Thanks,

Bart.

#3 lore raw
Quoted 8 lines · Bart Van Assche
Quoted 2 lines · Avri Altman
Quoted 1 line
Fixes 4b828fe156a6 ("scsi: ufs: revamp string descriptor reading")

I think this code goes back to commit b573d484e4ff (scsi: ufs: add support to read device and string descriptors)

Hmm ... it seems to me that there was no buffer overflow in commit b573d484e4ff but that the buffer overflow was introduced by commit 4b828fe156a6?

Thank you for the review Avri.

To me, it appears as if those two commits had different issues:

commit b573d484e4ff ("scsi: ufs: add support to read device and string descriptors") failed to reliably NULL terminate the output string (in the case where ascii_len == size - QUERY_DESC_HDR_SIZE).

commit 4b828fe156a6 ("scsi: ufs: revamp string descriptor reading") potentially performs an out-of-bounds array access while NULL terminating the output string.

I would argue that the proposed fix wouldn't even fix the former and older commit b573d484e4ff, because that commit might have required more fixes like using kzalloc instead of kmalloc.
I find that the newer commit 4b828fe156a6 did enough of refactoring for it to be considered the commit that needs this fix.

#4 lore raw
In reply to Daniel Mentz

Daniel,

Quoted 5 lines

utf16s_to_utf8s does not NULL terminate the output string. For us to be able to add a NULL character when utf16s_to_utf8s returns, we need to make sure that there is space for such NULL character at the end of the output buffer. We can achieve this by passing an output buffer size to utf16s_to_utf8s that is one character less than what we allocated.

Applied to 6.7/scsi-staging, thanks!

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering