scsi: Avoid possible run-time warning with long manufacturer strings
Subsystems (6)
cover scsi: Avoid possible run-time warning with long manufacturer strings
Hi,
Another code pattern using the gloriously ambiguous strncpy() function was turning maybe not-NUL-terminated character arrays into NUL-terminated strings. In these cases, when strncpy() is replaced with strscpy() it creates a situation where if the non-terminated string takes up the entire character array (i.e. it is not terminated) run-time warnings from CONFIG_FORTIFY_SOURCE will trip, since strscpy() was expecting to find a NUL-terminated source but checking for the NUL would walk off the end of the source buffer.
In doing an instrumented build of the kernel to find these cases, it seems it was almost entirely a code pattern used in the SCSI subsystem, so the creation of the new helper, memtostr(), can land via the SCSI tree. And, as it turns out, inappropriate conversions have been happening for several years now, some of which even moved through strlcpy() first (and were never noticed either).
This series fixes all 4 of the instances I could find in the SCSI subsystem.
Thanks,
-Kees
Kees Cook (5):
string.h: Introduce memtostr() and memtostr_pad()
scsi: mptfusion: Avoid possible run-time warning with long
manufacturer strings
scsi: mpt3sas: Avoid possible run-time warning with long manufacturer
strings
scsi: mpi3mr: Avoid possible run-time warning with long manufacturer
strings
scsi: qla2xxx: Avoid possible run-time warning with long model_num
drivers/message/fusion/mptsas.c | 14 +++---- drivers/scsi/mpi3mr/mpi3mr_transport.c | 14 +++---- drivers/scsi/mpt3sas/mpt3sas_base.c | 2 +- drivers/scsi/mpt3sas/mpt3sas_transport.c | 14 +++---- drivers/scsi/qla2xxx/qla_mr.c | 6 +-- include/linux/string.h | 49 ++++++++++++++++++++++++ lib/strscpy_kunit.c | 26 +++++++++++++ 7 files changed, 93 insertions(+), 32 deletions(-)
Signature · 1 line
2.34.1
PATCH 1/5 string.h: Introduce memtostr() and memtostr_pad()
Another ambiguous use of strncpy() is to copy from strings that may not be NUL-terminated. These cases depend on having the destination buffer be explicitly larger than the source buffer's maximum size, having the size of the copy exactly match the source buffer's maximum size, and for the destination buffer to get explicitly NUL terminated.
This usually happens when parsing protocols or hardware character arrays that are not guaranteed to be NUL-terminated. The code pattern is effectively this:
char dest[sizeof(src) + 1]; strncpy(dest, src, sizeof(src)); dest[sizeof(dest) - 1] = '\0';
In practice it usually looks like:
struct from_hardware {
...
char name[HW_NAME_SIZE] __nonstring;
...
};struct from_hardware *p = ...; char name[HW_NAME_SIZE + 1]; strncpy(name, p->name, HW_NAME_SIZE); name[NW_NAME_SIZE] = '\0';
This cannot be replaced with:
strscpy(name, p->name, sizeof(name));
because p->name is smaller and not NUL-terminated, so FORTIFY will trigger when strnlen(p->name, sizeof(name)) is used. And it cannot be replaced with:
strscpy(name, p->name, sizeof(p->name));
because then "name" may contain a 1 character early truncation of p->name.
Provide an unambiguous interface for converting a maybe not-NUL-terminated string to a NUL-terminated string, with compile-time buffer size checking so that it can never fail at runtime: memtostr() and memtostr_pad(). Also add KUnit tests for both.
---
Cc: Justin Stitt <[email protected]>
Cc: Andy Shevchenko <[email protected]>
Cc: [email protected]
--- include/linux/string.h | 49 ++++++++++++++++++++++++++++++++++++++++++ lib/strscpy_kunit.c | 26 ++++++++++++++++++++++ 2 files changed, 75 insertions(+)
include/linux/string.h +49 -0
@@ -424,6 +424,55 @@ void memcpy_and_pad(void *dest, size_t dest_len, const void *src, size_t count,memcpy (dest, src,strnlen (src,min (_src_len, _dest_len))); \ }while (0 ) +/** +* memtostr - Copy a possibly non-NUL-term string to a NUL-term string +* @dest: Pointer to destination NUL-terminates string +* @src: Pointer to character array (likely marked as __nonstring) +* +* This is a replacement for strncpy() uses where the source is not +* a NUL-terminated string. +* +* Note that sizes of @dest and @src must be known at compile-time. + */ +#define memtostr (dest, src) do { \ + const size_t _dest_len = __builtin_object_size(dest, 1); \ + const size_t _src_len = __builtin_object_size(src, 1); \ + const size_t _src_chars = strnlen(src, _src_len); \ + const size_t _copy_len = min(_dest_len - 1, _src_chars); \ + \ + BUILD_BUG_ON(!__builtin_constant_p(_dest_len) || \ + !__builtin_constant_p(_src_len) || \ + _dest_len == 0 || _dest_len == (size_t)-1 || \ + _src_len == 0 || _src_len == (size_t)-1); \ + memcpy(dest, src, _copy_len); \ + dest[_copy_len] = '\0'; \ +} while (0) + +/** +* memtostr_pad - Copy a possibly non-NUL-term string to a NUL-term string +* with NUL padding in the destination +* @dest: Pointer to destination NUL-terminates string +* @src: Pointer to character array (likely marked as __nonstring) +* +* This is a replacement for strncpy() uses where the source is not +* a NUL-terminated string. +* +* Note that sizes of @dest and @src must be known at compile-time. +*/ +#define memtostr_pad (dest, src) do { \ + const size_t _dest_len = __builtin_object_size(dest, 1); \ + const size_t _src_len = __builtin_object_size(src, 1); \ + const size_t _src_chars = strnlen(src, _src_len); \ + const size_t _copy_len = min(_dest_len - 1, _src_chars); \ + \ + BUILD_BUG_ON(!__builtin_constant_p(_dest_len) || \ + !__builtin_constant_p(_src_len) || \ + _dest_len == 0 || _dest_len == (size_t)-1 || \ + _src_len == 0 || _src_len == (size_t)-1); \ + memcpy(dest, src, _copy_len); \ + memset(&dest[_copy_len], 0, _dest_len - _copy_len); \ +} while (0) +/** * memset_after - Set a value after a struct member to the end of a struct *
lib/strscpy_kunit.c +26 -0
@@ -126,8 +126,34 @@ static void strscpy_test(struct kunit *test)KUNIT_EXPECT_EQ (test,strscpy (dest,"This is too long" ,ARRAY_SIZE (dest)), -E2BIG ); } +static void memtostr_test (struct kunit *test) +{ +char nonstring[7 ] = {'a' ,'b' ,'c' ,'d' ,'e' ,'f' ,'g' }; +char nonstring_small[3 ] = {'a' ,'b' ,'c' }; +char dest[sizeof (nonstring) +1 ]; + +/* Copy in a non-NUL-terminated string into exactly right-sized dest. */ +KUNIT_EXPECT_EQ (test,sizeof (dest),sizeof (nonstring) +1 ); +memset (dest,'X' ,sizeof (dest)); +memtostr (dest, nonstring); +KUNIT_EXPECT_STREQ (test, dest,"abcdefg" ); +memset (dest,'X' ,sizeof (dest)); +memtostr (dest, nonstring_small); +KUNIT_EXPECT_STREQ (test, dest,"abc" ); +KUNIT_EXPECT_EQ (test, dest[7 ],'X' ); + +memset (dest,'X' ,sizeof (dest)); +memtostr_pad (dest, nonstring); +KUNIT_EXPECT_STREQ (test, dest,"abcdefg" ); +memset (dest,'X' ,sizeof (dest)); +memtostr_pad (dest, nonstring_small); +KUNIT_EXPECT_STREQ (test, dest,"abc" ); +KUNIT_EXPECT_EQ (test, dest[7 ],'\0' ); +} +static struct kunit_case strscpy_test_cases[] = {KUNIT_CASE (strscpy_test), +KUNIT_CASE (memtostr_test), {} };
Signature · 1 line
2.34.1
Re: [PATCH 1/5] string.h: Introduce memtostr() and memtostr_pad()
Quoted 40 lines · Kees Cook
Another ambiguous use of
strncpy()is to copy from strings that may not be NUL-terminated. These cases depend on having the destination buffer be explicitly larger than the source buffer's maximum size, having the size of the copy exactly match the source buffer's maximum size, and for the destination buffer to get explicitly NUL terminated.This usually happens when parsing protocols or hardware character arrays that are not guaranteed to be NUL-terminated. The code pattern is effectively this:
char dest[sizeof(src) + 1]; strncpy(dest, src, sizeof(src)); dest[sizeof(dest) - 1] = '\0';In practice it usually looks like:
struct from_hardware { ... char name[HW_NAME_SIZE] __nonstring; ... };struct from_hardware *p = ...; char name[HW_NAME_SIZE + 1]; strncpy(name, p->name, HW_NAME_SIZE); name[NW_NAME_SIZE] = '\0';This cannot be replaced with:
strscpy(name, p->name, sizeof(name));because
p->nameis smaller and not NUL-terminated, so FORTIFY will trigger whenstrnlen(p->name, sizeof(name))is used. And it cannot be replaced with:strscpy(name, p->name, sizeof(p->name));
Quoted 7 lines
because then "name" may contain a 1 character early truncation of
p->name.Provide an unambiguous interface for converting a maybe not-NUL-terminated string to a NUL-terminated string, with compile-time buffer size checking so that it can never fail at runtime:
memtostr()andmemtostr_pad(). Also add KUnit tests for both.
Obvious question, why can't strscpy() be fixed for this corner case?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH 1/5] string.h: Introduce memtostr() and memtostr_pad()
Quoted 44 lines · Andy Shevchenko
Quoted 43 lines · Kees Cook
Another ambiguous use of
strncpy()is to copy from strings that may not be NUL-terminated. These cases depend on having the destination buffer be explicitly larger than the source buffer's maximum size, having the size of the copy exactly match the source buffer's maximum size, and for the destination buffer to get explicitly NUL terminated.This usually happens when parsing protocols or hardware character arrays that are not guaranteed to be NUL-terminated. The code pattern is effectively this:
char dest[sizeof(src) + 1]; strncpy(dest, src, sizeof(src)); dest[sizeof(dest) - 1] = '\0';In practice it usually looks like:
struct from_hardware { ... char name[HW_NAME_SIZE] __nonstring; ... };struct from_hardware *p = ...; char name[HW_NAME_SIZE + 1]; strncpy(name, p->name, HW_NAME_SIZE); name[NW_NAME_SIZE] = '\0';This cannot be replaced with:
strscpy(name, p->name, sizeof(name));because
p->nameis smaller and not NUL-terminated, so FORTIFY will trigger whenstrnlen(p->name, sizeof(name))is used. And it cannot be replaced with:strscpy(name, p->name, sizeof(p->name));because then "name" may contain a 1 character early truncation of
p->name.
Quoted 6 lines
Quoted 4 lines
Provide an unambiguous interface for converting a maybe not-NUL-terminated string to a NUL-terminated string, with compile-time buffer size checking so that it can never fail at runtime:
memtostr()andmemtostr_pad(). Also add KUnit tests for both.Obvious question, why can't
strscpy()be fixed for this corner case?
We would lose the ability to detect normal out-of-bounds reads, or at least make them ambiguous. I really want these APIs to have distinct and dependable semantics/behaviors.
Signature · 1 line
Kees Cook
Re: [PATCH 1/5] string.h: Introduce memtostr() and memtostr_pad()
In reply to Kees CookQuoted 42 lines · Kees Cook
Another ambiguous use of
strncpy()is to copy from strings that may not be NUL-terminated. These cases depend on having the destination buffer be explicitly larger than the source buffer's maximum size, having the size of the copy exactly match the source buffer's maximum size, and for the destination buffer to get explicitly NUL terminated.This usually happens when parsing protocols or hardware character arrays that are not guaranteed to be NUL-terminated. The code pattern is effectively this:
char dest[sizeof(src) + 1]; strncpy(dest, src, sizeof(src)); dest[sizeof(dest) - 1] = '\0';In practice it usually looks like:
struct from_hardware { ... char name[HW_NAME_SIZE] __nonstring; ... };struct from_hardware *p = ...; char name[HW_NAME_SIZE + 1]; strncpy(name, p->name, HW_NAME_SIZE); name[NW_NAME_SIZE] = '\0';This cannot be replaced with:
strscpy(name, p->name, sizeof(name));because
p->nameis smaller and not NUL-terminated, so FORTIFY will trigger whenstrnlen(p->name, sizeof(name))is used. And it cannot be replaced with:strscpy(name, p->name, sizeof(p->name));because then "name" may contain a 1 character early truncation of
p->name.
Quoted 6 lines
Provide an unambiguous interface for converting a maybe not-NUL-terminated string to a NUL-terminated string, with compile-time buffer size checking so that it can never fail at runtime:
memtostr()andmemtostr_pad(). Also add KUnit tests for both.Signed-off-by Kees Cook <[email protected]>
FYI,
As the string KUnit tests have seen some refactoring, I'm taking this patch and refactoring it onto my tree. Once the SCSI fixes are reviewed, if we want to land them in -next, it's probably easiest for them to go via my tree.
-Kees
Signature · 1 line
Kees Cook
Re: [PATCH 1/5] string.h: Introduce memtostr() and memtostr_pad()
Kees,
Quoted 4 lines
As the string KUnit tests have seen some refactoring, I'm taking this patch and refactoring it onto my tree. Once the SCSI fixes are reviewed, if we want to land them in -next, it's probably easiest for them to go via my tree.
Sure, no problem.
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
PATCH 2/5 scsi: mptfusion: Avoid possible run-time warning with long manufacturer strings
In reply to Kees CookThe prior strscpy() replacement of strncpy() here expected the manufacture_reply strings to be NUL-terminated, but it is possible they are not, as the code pattern here shows, e.g., edev->vendor_id being exactly 1 character larger than manufacture_reply->vendor_id, and the replaced strncpy() was copying only up to the size of the source character array. Replace this with memtostr(), which is the unambiguous way to convert a maybe not-NUL-terminated character array into a NUL-terminated string.
---
Cc: Justin Stitt <[email protected]>
Cc: Sathya Prakash <[email protected]>
Cc: Sreekanth Reddy <[email protected]>
Cc: Suganath Prabu Subramani <[email protected]>
Cc: [email protected]
Cc: [email protected]
--- drivers/message/fusion/mptsas.c | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-)
drivers/message/fusion/mptsas.c +5 -9
@@ -2964,17 +2964,13 @@ mptsas_exp_repmanufacture_info(MPT_ADAPTER *ioc, goto out_free; manufacture_reply = data_out +sizeof (struct rep_manu_request ); -strscpy (edev->vendor_id, manufacture_reply->vendor_id, -sizeof (edev->vendor_id)); -strscpy (edev->product_id, manufacture_reply->product_id, -sizeof (edev->product_id)); -strscpy (edev->product_rev, manufacture_reply->product_rev, -sizeof (edev->product_rev)); +memtostr (edev->vendor_id, manufacture_reply->vendor_id); +memtostr (edev->product_id, manufacture_reply->product_id); +memtostr (edev->product_rev, manufacture_reply->product_rev); edev->level = manufacture_reply->sas_format;if (manufacture_reply->sas_format) { -strscpy (edev->component_vendor_id, - manufacture_reply->component_vendor_id, -sizeof (edev->component_vendor_id)); +memtostr (edev->component_vendor_id, + manufacture_reply->component_vendor_id); tmp = (u8 *)&manufacture_reply->component_id; edev->component_id = tmp[0 ] <<8 | tmp[1 ]; edev->component_revision_id =
Signature · 1 line
2.34.1
PATCH 3/5 scsi: mpt3sas: Avoid possible run-time warning with long manufacturer strings
In reply to Kees CookThe prior strscpy() replacement of strncpy() here expected the manufacture_reply strings to be NUL-terminated, but it is possible they are not, as the code pattern here shows, e.g., edev->vendor_id being exactly 1 character larger than manufacture_reply->vendor_id, and the replaced strncpy() was copying only up to the size of the source character array. Replace this with memtostr(), which is the unambiguous way to convert a maybe not-NUL-terminated character array into a NUL-terminated string.
---
Cc: Justin Stitt <[email protected]>
Cc: Sathya Prakash <[email protected]>
Cc: Sreekanth Reddy <[email protected]>
Cc: Suganath Prabu Subramani <[email protected]>
Cc: "James E.J. Bottomley" <[email protected]>
Cc: "Martin K. Petersen" <[email protected]>
Cc: [email protected]
Cc: [email protected]
--- drivers/scsi/mpt3sas/mpt3sas_base.c | 2 +- drivers/scsi/mpt3sas/mpt3sas_transport.c | 14 +++++--------- 2 files changed, 6 insertions(+), 10 deletions(-)
drivers/scsi/mpt3sas/mpt3sas_base.c +1 -1
@@ -4774,7 +4774,7 @@ _base_display_ioc_capabilities(struct MPT3SAS_ADAPTER *ioc)char desc[17 ] = {0 };u32 iounit_pg1_flags; -strscpy (desc, ioc->manu_pg0.ChipName,sizeof (desc)); +memtostr (desc, ioc->manu_pg0.ChipName); ioc_info(ioc, "%s: FWVersion(%02d.%02d.%02d.%02d), ChipRevision(0x%02x)\n", desc, (ioc->facts.FWVersion.Word & 0xFF000000) >> 24,
drivers/scsi/mpt3sas/mpt3sas_transport.c +5 -9
@@ -458,17 +458,13 @@ _transport_expander_report_manufacture(struct MPT3SAS_ADAPTER *ioc, goto out; manufacture_reply = data_out +sizeof (struct rep_manu_request ); -strscpy (edev->vendor_id, manufacture_reply->vendor_id, -sizeof (edev->vendor_id)); -strscpy (edev->product_id, manufacture_reply->product_id, -sizeof (edev->product_id)); -strscpy (edev->product_rev, manufacture_reply->product_rev, -sizeof (edev->product_rev)); +memtostr (edev->vendor_id, manufacture_reply->vendor_id); +memtostr (edev->product_id, manufacture_reply->product_id); +memtostr (edev->product_rev, manufacture_reply->product_rev); edev->level = manufacture_reply->sas_format &1 ;if (edev->level) { -strscpy (edev->component_vendor_id, - manufacture_reply->component_vendor_id, -sizeof (edev->component_vendor_id)); +memtostr (edev->component_vendor_id, + manufacture_reply->component_vendor_id); tmp = (u8 *)&manufacture_reply->component_id; edev->component_id = tmp[0 ] <<8 | tmp[1 ]; edev->component_revision_id =
Signature · 1 line
2.34.1
Re: [PATCH 3/5] scsi: mpt3sas: Avoid possible run-time warning with long manufacturer strings
Quoted 67 lines · Kees Cook
The prior
strscpy()replacement ofstrncpy()here expected themanufacture_replystrings to be NUL-terminated, but it is possible they are not, as the code pattern here shows, e.g.,edev->vendor_idbeing exactly 1 character larger thanmanufacture_reply->vendor_id, and the replacedstrncpy()was copying only up to the size of the source character array. Replace this withmemtostr(), which is the unambiguous way to convert a maybe not-NUL-terminated character array into a NUL-terminated string.Fixes b7e9712a02e8 ("scsi: mpt3sas: Replace deprecated strncpy() with strscpy()")Signed-off-by Kees Cook <[email protected]>---
Cc: Justin Stitt <[email protected]>
Cc: Sathya Prakash <[email protected]>
Cc: Sreekanth Reddy <[email protected]>
Cc: Suganath Prabu Subramani <[email protected]>
Cc: "James E.J. Bottomley" <[email protected]>
Cc: "Martin K. Petersen" <[email protected]>
Cc: [email protected]
Cc: [email protected]--- drivers/scsi/mpt3sas/mpt3sas_base.c | 2 +- drivers/scsi/mpt3sas/mpt3sas_transport.c | 14 +++++--------- 2 files changed, 6 insertions(+), 10 deletions(-)drivers/scsi/mpt3sas/mpt3sas_base.c +1
-1@@ -4774,7 +4774,7 @@ _base_display_ioc_capabilities(struct MPT3SAS_ADAPTER *ioc)char desc[17 ] = {0 };u32 iounit_pg1_flags; -strscpy (desc, ioc->manu_pg0.ChipName,sizeof (desc)); +memtostr (desc, ioc->manu_pg0.ChipName); ioc_info(ioc, "%s: FWVersion(%02d.%02d.%02d.%02d), ChipRevision(0x%02x)\n", desc, (ioc->facts.FWVersion.Word & 0xFF000000) >> 24,drivers/scsi/mpt3sas/mpt3sas_transport.c +5
-10@@ -458,17 +458,13 @@ _transport_expander_report_manufacture(struct MPT3SAS_ADAPTER *ioc, goto out; manufacture_reply = data_out +sizeof (struct rep_manu_request ); -strscpy (edev->vendor_id, manufacture_reply->vendor_id, -sizeof (edev->vendor_id)); -strscpy (edev->product_id, manufacture_reply->product_id, -sizeof (edev->product_id)); -strscpy (edev->product_rev, manufacture_reply->product_rev, -sizeof (edev->product_rev)); +memtostr (edev->vendor_id, manufacture_reply->vendor_id); +memtostr (edev->product_id, manufacture_reply->product_id); +memtostr (edev->product_rev, manufacture_reply->product_rev); edev->level = manufacture_reply->sas_format &1 ;if (edev->level) { -strscpy (edev->component_vendor_id, - manufacture_reply->component_vendor_id, -sizeof (edev->component_vendor_id)); +memtostr (edev->component_vendor_id, + manufacture_reply->component_vendor_id); tmp = (u8 *)&manufacture_reply->component_id; edev->component_id = tmp[0 ] <<8 | tmp[1 ]; edev->component_revision_id = --
Quoted 3 lines
2.34.1
This fixes the following warning & subsequent panic seen on one of our test machines:
[ 4.986905] ------------[ cut here ]------------ [ 4.991545] strnlen: detected buffer overflow: 9 byte read of buffer size 8 [ 4.998528] WARNING: CPU: 2 PID: 13 at lib/string_helpers.c:1029 __fortify_report+0x3f/0x50 [ 5.006889] Modules linked in: qla2xxx(+) bnxt_en mpt3sas(+)
nvme_fc ahci crct10dif_pclmul libahci nvme_fabrics crc32_pclmul crc32c_intel nvme_core libata t10_pi raid_class ghash_clmulni_intel tg3 scsi_transport_fc scsi_transport_sas dimlib wmi dm_mirror dm_region_hash dm_log dm_mod
[ 5.031912] CPU: 2 PID: 13 Comm: kworker/u128:1 Not tainted 6.9.0+ #1 [ 5.038352] Hardware name: Dell Inc. PowerEdge R640/06NR82, BIOS 2.21.2 02/19/2024 [ 5.038355] Workqueue: fw_event_mpt3sas0 _firmware_event_work [mpt3sas] [ 5.052557] RIP: 0010:__fortify_report+0x3f/0x50 [ 5.052560] Code: c1 83 e7 01 48 c7 c1 5c 4d 08 b9 48 c7 c7 80 c1 01 b9 48 8b 34 c5 80 cc af b8 48 c7 c0 66 4d 08 b9 48 0f 45 c8 e8 01 a8 a8 ff <0f> 0b c3 cc cc cc cc 66 2e 0f 1f 84 00 00 00 00 00 90 90 90 90 90 [ 5.075926] RSP: 0018:ffffb972c02c7bb0 EFLAGS: 00010286 [ 5.075928] RAX: 0000000000000000 RBX: ffff915503b12100 RCX: 0000000000000000 [ 5.088284] RDX: ffff91586faaee40 RSI: ffff91586faa0bc0 RDI: ffff91586faa0bc0 [ 5.095418] RBP: ffff915503f11c08 R08: 0000000000000000 R09: ffffb972c02c7a60 [ 5.102549] R10: ffffb972c02c7a58 R11: ffffffffb95deba8 R12: ffff9155126ef010 [ 5.102551] R13: ffff9155086ecb50 R14: ffff9155126ef000 R15: ffff9155086ec848 [ 5.102552] FS: 0000000000000000(0000) GS:ffff91586fa80000(0000) knlGS:0000000000000000 [ 5.116816] CS: 0010 DS: 0000 ES: 0000 CR0: 0000000080050033 [ 5.120583] ata15.00: Security Log not supported [ 5.120723] ata15.00: Security Log not supported [ 5.130645] CR2: 00007f48a3d47a50 CR3: 00000003b2e20006 CR4: 00000000007706f0 [ 5.130647] DR0: 0000000000000000 DR1: 0000000000000000 DR2: 0000000000000000 [ 5.139880] DR3: 0000000000000000 DR6: 00000000fffe0ff0 DR7: 0000000000000400 [ 5.139882] PKRU: 55555554 [ 5.139883] Call Trace: [ 5.154146] <TASK> [ 5.163991] ? __warn+0x7f/0x120 [ 5.168549] ? __fortify_report+0x3f/0x50 [ 5.175791] ? report_bug+0x18a/0x1a0 [ 5.179479] ? handle_bug+0x3c/0x70 [ 5.182994] ? exc_invalid_op+0x14/0x70 [ 5.182997] ? asm_exc_invalid_op+0x16/0x20 [ 5.191021] ? __fortify_report+0x3f/0x50 [ 5.195033] __fortify_panic+0x9/0x10 [ 5.198699] _transport_expander_report_manufacture.isra.0+0x5f0/0x620 [mpt3sas] [ 5.206145] mpt3sas_transport_port_add+0x5df/0x7a0 [mpt3sas] [ 5.211931] _scsih_expander_add+0x28a/0x650 [mpt3sas] [ 5.217112] ? _scsih_sas_host_refresh+0x2aa/0x510 [mpt3sas] [ 5.222799] _scsih_sas_topology_change_event.isra.0+0x213/0x440 [mpt3sas] [ 5.229714] _mpt3sas_fw_work+0x6ab/0xb50 [mpt3sas] [ 5.234636] ? pick_next_task+0x9e2/0xae0 [ 5.238649] ? finish_task_switch.isra.0+0x97/0x290 [ 5.243555] ? move_linked_works+0x70/0xa0 [ 5.247661] process_one_work+0x184/0x3b0 [ 5.251673] worker_thread+0x2f9/0x410 [ 5.251677] ? __pfx_worker_thread+0x10/0x10 [ 5.251679] kthread+0xcc/0x100 [ 5.259713] ? __pfx_kthread+0x10/0x10 [ 5.259715] ret_from_fork+0x2d/0x50 [ 5.270190] ? __pfx_kthread+0x10/0x10 [ 5.273944] ret_from_fork_asm+0x1a/0x30 [ 5.277872] </TASK> [ 5.280062] ---[ end trace 0000000000000000 ]---
PATCH 4/5 scsi: mpi3mr: Avoid possible run-time warning with long manufacturer strings
In reply to Kees CookThe prior use of strscpy() here expected the manufacture_reply strings to be NUL-terminated, but it is possible they are not, as the code pattern here shows, e.g., edev->vendor_id being exactly 1 character larger than manufacture_reply->vendor_id, and the strscpy() was copying only up to the size of the source character array. Replace this with memtostr(), which is the unambiguous way to convert a maybe not-NUL-terminated character array into a NUL-terminated string.
---
Cc: Sreekanth Reddy <[email protected]>
Cc: Sathya Prakash Veerichetty <[email protected]>
Cc: Kashyap Desai <[email protected]>
Cc: Sumit Saxena <[email protected]>
Cc: "James E.J. Bottomley" <[email protected]>
Cc: "Martin K. Petersen" <[email protected]>
Cc: [email protected]
Cc: [email protected]
--- drivers/scsi/mpi3mr/mpi3mr_transport.c | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-)
drivers/scsi/mpi3mr/mpi3mr_transport.c +5 -9
@@ -211,17 +211,13 @@ static int mpi3mr_report_manufacture(struct mpi3mr_ioc *mrioc, goto out; } -strscpy (edev->vendor_id, manufacture_reply->vendor_id, -SAS_EXPANDER_VENDOR_ID_LEN ); -strscpy (edev->product_id, manufacture_reply->product_id, -SAS_EXPANDER_PRODUCT_ID_LEN ); -strscpy (edev->product_rev, manufacture_reply->product_rev, -SAS_EXPANDER_PRODUCT_REV_LEN ); +memtostr (edev->vendor_id, manufacture_reply->vendor_id); +memtostr (edev->product_id, manufacture_reply->product_id); +memtostr (edev->product_rev, manufacture_reply->product_rev); edev->level = manufacture_reply->sas_format &1 ;if (edev->level) { -strscpy (edev->component_vendor_id, - manufacture_reply->component_vendor_id, -SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN ); +memtostr (edev->component_vendor_id, + manufacture_reply->component_vendor_id); tmp = (u8 *)&manufacture_reply->component_id; edev->component_id = tmp[0 ] <<8 | tmp[1 ]; edev->component_revision_id =
Signature · 1 line
2.34.1
PATCH 5/5 scsi: qla2xxx: Avoid possible run-time warning with long model_num
In reply to Kees CookThe prior strlcpy() replacement of strncpy() here (which was later replaced with strscpy()) expected pinfo->model_num (and pinfo->model_description) to be NUL-terminated, but it is possible it was not, as the code pattern here shows vha->hw->model_number (and vha->hw->model_desc) being exactly 1 character larger, and the replaced strncpy() was copying only up to the size of the source character array. Replace this with memtostr(), which is the unambiguous way to convert a maybe not-NUL-terminated character array into a NUL-terminated string.
---
Cc: Bart Van Assche <[email protected]>
Cc: Nilesh Javali <[email protected]>
Cc: [email protected]
Cc: "James E.J. Bottomley" <[email protected]>
Cc: "Martin K. Petersen" <[email protected]>
Cc: [email protected]
--- drivers/scsi/qla2xxx/qla_mr.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-)
drivers/scsi/qla2xxx/qla_mr.c +2 -4
@@ -1909,10 +1909,8 @@ qlafx00_fx_disc(scsi_qla_host_t *vha, fc_port_t *fcport, uint16_t fx_type)if (fx_type ==FXDISC_GET_CONFIG_INFO ) {struct config_info_data *pinfo = (struct config_info_data *) fdisc->u.fxiocb.rsp_addr; -strscpy (vha->hw->model_number, pinfo->model_num, -ARRAY_SIZE (vha->hw->model_number)); -strscpy (vha->hw->model_desc, pinfo->model_description, -ARRAY_SIZE (vha->hw->model_desc)); +memtostr (vha->hw->model_number, pinfo->model_num); +memtostr (vha->hw->model_desc, pinfo->model_description);memcpy (&vha->hw->mr.symbolic_name, pinfo->symbolic_name,sizeof (vha->hw->mr.symbolic_name)); memcpy(&vha->hw->mr.serial_num, pinfo->serial_num,
Signature · 1 line
2.34.1
Quoted 18 lines · Kees Cook
Hi,
Another code pattern using the gloriously ambiguous
strncpy()function was turning maybe not-NUL-terminated character arrays into NUL-terminated strings. In these cases, whenstrncpy()is replaced withstrscpy()it creates a situation where if the non-terminated string takes up the entire character array (i.e. it is not terminated) run-time warnings fromCONFIG_FORTIFY_SOURCEwill trip, sincestrscpy()was expecting to find a NUL-terminated source but checking for the NUL would walk off the end of the source buffer.In doing an instrumented build of the kernel to find these cases, it seems it was almost entirely a code pattern used in the SCSI subsystem, so the creation of the new helper,
memtostr(), can land via the SCSI tree. And, as it turns out, inappropriate conversions have been happening for several years now, some of which even moved throughstrlcpy()first (and were never noticed either).
Quoted 2 lines
This series fixes all 4 of the instances I could find in the SCSI subsystem.
Friendly ping. Can the SCSI tree pick this up, or should I take it through the hardening tree?
Thanks!
-Kees
Quoted 27 lines
Thanks,
-Kees
Kees Cook (5):
string.h: Introducememtostr()andmemtostr_pad()
scsi: mptfusion: Avoid possible run-time warning with long
manufacturer strings
scsi: mpt3sas: Avoid possible run-time warning with long manufacturer
strings
scsi: mpi3mr: Avoid possible run-time warning with long manufacturer
strings
scsi: qla2xxx: Avoid possible run-time warning with longmodel_numdrivers/message/fusion/mptsas.c | 14 +++---- drivers/scsi/mpi3mr/mpi3mr_transport.c | 14 +++---- drivers/scsi/mpt3sas/mpt3sas_base.c | 2 +- drivers/scsi/mpt3sas/mpt3sas_transport.c | 14 +++---- drivers/scsi/qla2xxx/qla_mr.c | 6 +-- include/linux/string.h | 49 ++++++++++++++++++++++++ lib/strscpy_kunit.c | 26 +++++++++++++ 7 files changed, 93 insertions(+), 32 deletions(-)Signature · 1 line
2.34.1
Signature · 1 line
Kees Cook
Hi Kees!
Quoted 5 lines
Quoted 2 lines
This series fixes all 4 of the instances I could find in the SCSI subsystem.
Friendly ping. Can the SCSI tree pick this up, or should I take it through the hardening tree?
It's on my list of series to review. Have a couple of fires going right now.
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
Quoted 11 lines · Martin K. Petersen
Hi Kees!
Quoted 5 lines
Quoted 2 lines
This series fixes all 4 of the instances I could find in the SCSI subsystem.
Friendly ping. Can the SCSI tree pick this up, or should I take it through the hardening tree?
It's on my list of series to review. Have a couple of fires going right now.
Okay, thanks! I just wanted to make sure it got picked up for v6.9 since it fixes a real-world issue. :)
Signature · 1 line
Kees Cook
Kees,
Quoted 2 lines
This series fixes all 4 of the instances I could find in the SCSI subsystem.
Looks OK to me.
Minor nit: I do find it a bit odd to think of a string as "memory". Maybe that's just because I am so used to always having to distinguish between fixed length strings and NUL-terminated strings in the storage protocols and hardware programming interfaces. But both types are definitely referred to as "strings" colloquially and not so much "memory".
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering