scsi: qedf: sanitise uaccess
Subsystems (2)
v2 cover scsi: qedf: sanitise uaccess
qedf driver, debugfs part of it specifically, touches __user pointers directly for printing out info to userspace via sprintf(), which may cause crash like this:
BUG: unable to handle kernel paging request at 00007ffd1d6b43a0 IP: [<ffffffffaa7a882a>] string.isra.7+0x6a/0xf0 Oops: 0003 [#1] SMP Call Trace: [<ffffffffaa7a9f31>] vsnprintf+0x201/0x6a0 [<ffffffffaa7aa556>] sprintf+0x56/0x80 [<ffffffffc04227ed>] qedf_dbg_stop_io_on_error_cmd_read+0x6d/0x90 [qedf] [<ffffffffaa65bb2f>] vfs_read+0x9f/0x170 [<ffffffffaa65cb82>] SyS_pread64+0x92/0xc0
Avoid this by preparing the info in a kernel buffer first, either allocated on stack for small printouts, or via vmalloc() for big ones, and then copying it to the userspace properly.
Changes since v1 [1]:
* use scnprintf() for on-stack buffers too
* adjust an on-stack buffer size in qedf_dbg_debug_cmd_read() to be a multiple of 8, and also size it properly
* accumulate acks and reviews
[1] https://lore.kernel.org/lkml/[email protected]/
Oleksandr Natalenko (3):
scsi: qedf: do not touch __user pointer in
qedf_dbg_stop_io_on_error_cmd_read() directly
scsi: qedf: do not touch __user pointer in qedf_dbg_debug_cmd_read()
directly
scsi: qedf: do not touch __user pointer in qedf_dbg_fp_int_cmd_read()
directly
drivers/scsi/qedf/qedf_dbg.h | 2 ++ drivers/scsi/qedf/qedf_debugfs.c | 35 +++++++++++++++++++------------- 2 files changed, 23 insertions(+), 14 deletions(-)
Signature · 1 line
2.41.0
PATCH v2 1/3 scsi: qedf: do not touch __user pointer in qedf_dbg_stop_io_on_error_cmd_read() directly
The qedf_dbg_stop_io_on_error_cmd_read() function invokes sprintf() directly on a __user pointer, which may crash the kernel.
Avoid doing that by using a small on-stack buffer for scnprintf() and then calling simple_read_from_buffer() which does a proper copy_to_user() call.
--- drivers/scsi/qedf/qedf_debugfs.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/scsi/qedf/qedf_debugfs.c +3 -4
@@ -185,18 +185,17 @@ qedf_dbg_stop_io_on_error_cmd_read(struct file *filp, char __user *buffer, size_t count, loff_t *ppos) { int cnt; +char cbuf[7 ];struct qedf_dbg_ctx *qedf_dbg = (struct qedf_dbg_ctx *)filp->private_data;struct qedf_ctx *qedf =container_of (qedf_dbg, struct qedf_ctx, dbg_ctx);QEDF_INFO (qedf_dbg,QEDF_LOG_DEBUGFS ,"entered\n" ); - cnt =sprintf (buffer,"%s\n" , + cnt =scnprintf (cbuf,sizeof (cbuf),"%s\n" , qedf->stop_io_on_error ?"true" :"false" ); - cnt =min_t (int, count, cnt - *ppos); - *ppos += cnt; -return cnt; +return simple_read_from_buffer (buffer, count, ppos, cbuf, cnt); } static ssize_t
Signature · 1 line
2.41.0
PATCH v2 2/3 scsi: qedf: do not touch __user pointer in qedf_dbg_debug_cmd_read() directly
In reply to Oleksandr NatalenkoThe qedf_dbg_debug_cmd_read() function invokes sprintf() directly on a __user pointer, which may crash the kernel.
Avoid doing that by using a small on-stack buffer for scnprintf() and then calling simple_read_from_buffer() which does a proper copy_to_user() call.
--- drivers/scsi/qedf/qedf_debugfs.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/scsi/qedf/qedf_debugfs.c +3 -4
@@ -138,15 +138,14 @@ qedf_dbg_debug_cmd_read(struct file *filp, char __user *buffer, size_t count, loff_t *ppos) {int cnt; +char cbuf[32 ];struct qedf_dbg_ctx *qedf_dbg = (struct qedf_dbg_ctx *)filp->private_data;QEDF_INFO (qedf_dbg,QEDF_LOG_DEBUGFS ,"debug mask=0x%x\n" , qedf_debug); - cnt =sprintf (buffer,"debug mask = 0x%x\n" , qedf_debug); + cnt =scnprintf (cbuf,sizeof (cbuf),"debug mask = 0x%x\n" , qedf_debug); - cnt =min_t (int, count, cnt - *ppos); - *ppos += cnt; -return cnt; +return simple_read_from_buffer (buffer, count, ppos, cbuf, cnt); } static ssize_t
Signature · 1 line
2.41.0
PATCH v2 3/3 scsi: qedf: do not touch __user pointer in qedf_dbg_fp_int_cmd_read() directly
In reply to Oleksandr NatalenkoThe qedf_dbg_fp_int_cmd_read() function invokes sprintf() directly on a __user pointer, which may crash the kernel.
Avoid doing that by vmalloc()'ating a buffer for scnprintf() and then calling simple_read_from_buffer() which does a proper copy_to_user() call.
--- drivers/scsi/qedf/qedf_dbg.h | 2 ++ drivers/scsi/qedf/qedf_debugfs.c | 21 +++++++++++++++------ 2 files changed, 17 insertions(+), 6 deletions(-)
drivers/scsi/qedf/qedf_dbg.h +2 -0
@@ -59,6 +59,8 @@ extern uint qedf_debug;#define QEDF_LOG_NOTICE 0x40000000/* Notice logs */ #define QEDF_LOG_WARN 0x80000000/* Warning logs */ +#define QEDF_DEBUGFS_LOG_LEN (2 * PAGE_SIZE) +/* Debug context structure */ struct qedf_dbg_ctx {unsigned int host_no;
drivers/scsi/qedf/qedf_debugfs.c +15 -6
@@ -8,6 +8,7 @@#include <linux/uaccess.h> #include <linux/debugfs.h> #include <linux/module.h> +#include <linux/vmalloc.h> #include "qedf.h" #include "qedf_dbg.h"
@@ -98,7 +99,9 @@ static ssize_t qedf_dbg_fp_int_cmd_read(struct file *filp, char __user *buffer, size_t count, loff_t *ppos) { + ssize_t ret;size_t cnt =0 ; +char *cbuf;int id;struct qedf_fastpath *fp =NULL ; struct qedf_dbg_ctx *qedf_dbg =
@@ -108,19 +111,25 @@ qedf_dbg_fp_int_cmd_read(struct file *filp, char __user *buffer, size_t count,QEDF_INFO (qedf_dbg,QEDF_LOG_DEBUGFS ,"entered\n" ); - cnt =sprintf (buffer,"\nFastpath I/O completions\n\n" ); + cbuf =vmalloc (QEDF_DEBUGFS_LOG_LEN ); +if (!cbuf) +return 0 ; + + cnt +=scnprintf (cbuf + cnt,QEDF_DEBUGFS_LOG_LEN - cnt,"\nFastpath I/O completions\n\n" );for (id =0 ; id < qedf->num_queues; id++) { fp = &(qedf->fp_array[id]);if (fp->sb_id ==QEDF_SB_ID_NULL )continue ; - cnt +=sprintf ((buffer + cnt),"#%d: %lu\n" , id, - fp->completions); + cnt +=scnprintf (cbuf + cnt,QEDF_DEBUGFS_LOG_LEN - cnt, +"#%d: %lu\n" , id, fp->completions); } - cnt =min_t (int, count, cnt - *ppos); - *ppos += cnt; -return cnt; + ret =simple_read_from_buffer (buffer, count, ppos, cbuf, cnt); + +vfree (cbuf); + +return ret; } static ssize_t
Signature · 1 line
2.41.0
Quoted 41 lines · Oleksandr Natalenko
qedf driver, debugfs part of it specifically, touches
__userpointers directly for printing out info to userspace viasprintf(), which may cause crash like this:BUG: unable to handle kernel paging request at 00007ffd1d6b43a0 IP: [<ffffffffaa7a882a>] string.isra.7+0x6a/0xf0 Oops: 0003 [#1] SMP Call Trace: [<ffffffffaa7a9f31>] vsnprintf+0x201/0x6a0 [<ffffffffaa7aa556>] sprintf+0x56/0x80 [<ffffffffc04227ed>] qedf_dbg_stop_io_on_error_cmd_read+0x6d/0x90 [qedf] [<ffffffffaa65bb2f>] vfs_read+0x9f/0x170 [<ffffffffaa65cb82>] SyS_pread64+0x92/0xc0Avoid this by preparing the info in a kernel buffer first, either allocated on stack for small printouts, or via
vmalloc()for big ones,
and then copying it to the userspace properly.Changes since v1 [1]:
* use
scnprintf()for on-stack buffers too
* adjust an on-stack buffer size inqedf_dbg_debug_cmd_read()to be a
multiple of 8, and also size it properly
* accumulate acks and reviews[1]
https://lore.kernel.org/lkml/[email protected]/Oleksandr Natalenko (3):
scsi: qedf: do not touch__userpointer in
qedf_dbg_stop_io_on_error_cmd_read()directly
scsi: qedf: do not touch__userpointer inqedf_dbg_debug_cmd_read()
directly
scsi: qedf: do not touch__userpointer inqedf_dbg_fp_int_cmd_read()
directly
Quoted 5 lines
drivers/scsi/qedf/qedf_dbg.h | 2 ++
drivers/scsi/qedf/qedf_debugfs.c| 35 +++++++++++++++++++----------- --2 files changed, 23 insertions(+), 14 deletions(-)
In case it's needed
For the series v2 against 6.5-rc3
Test notes
Linux segstorage5 6.5.0-rc3+
[root@segstorage5 qedf]# cd host2
[root@segstorage5 host2]# lsclear_stats debug driver_stats fp_int io_trace offload_stats stop_io_on_error
[root@segstorage5 host2]# cat stop_io_on_error
false
[root@segstorage5 host2]# cat fp_int
Fastpath I/O completions
#0: 844
#1: 990
#2: 1036
#3: 1116
#4: 953
#5: 822
#6: 882
#7: 1073
#8: 1030
#9: 992
#10: 789
#11: 705
#12: 490
#13: 532
#14: 646
#15: 705
[root@segstorage5 host2]# cat debug
debug mask = 0x2
Martin K. Petersen
AppliedOleksandr,
Quoted 3 lines
qedf driver, debugfs part of it specifically, touches
__userpointers directly for printing out info to userspace viasprintf(), which may cause crash like this:
Applied to 6.6/scsi-staging, thanks!
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
Quoted 8 lines · On pondělí 31. července 2023 20:43:34 CEST Martin K. Petersen wrote:
Oleksandr,
Quoted 3 lines
qedf driver, debugfs part of it specifically, touches
__userpointers directly for printing out info to userspace viasprintf(), which may cause crash like this:Applied to 6.6/scsi-staging, thanks!
Thank you all.
Signature · 2 lines
Oleksandr Natalenko (post-factum) Principal Software Maintenance Engineer
Martin K. Petersen
AppliedQuoted 14 lines · Oleksandr Natalenko
qedf driver, debugfs part of it specifically, touches
__userpointers directly for printing out info to userspace viasprintf(), which may cause crash like this:BUG: unable to handle kernel paging request at 00007ffd1d6b43a0 IP: [<ffffffffaa7a882a>] string.isra.7+0x6a/0xf0 Oops: 0003 [#1] SMP Call Trace: [<ffffffffaa7a9f31>] vsnprintf+0x201/0x6a0 [<ffffffffaa7aa556>] sprintf+0x56/0x80 [<ffffffffc04227ed>] qedf_dbg_stop_io_on_error_cmd_read+0x6d/0x90 [qedf] [<ffffffffaa65bb2f>] vfs_read+0x9f/0x170 [<ffffffffaa65cb82>] SyS_pread64+0x92/0xc0
Quoted 1 line
[...]
Applied to 6.6/scsi-queue, thanks!
[1/3] scsi: qedf: do not touch __user pointer in qedf_dbg_stop_io_on_error_cmd_read() directly
https://git.kernel.org/mkp/scsi/c/7d3d20dee4f6 [2/3] scsi: qedf: do not touch __user pointer in qedf_dbg_debug_cmd_read() directly https://git.kernel.org/mkp/scsi/c/31b5991a9a91 [3/3] scsi: qedf: do not touch __user pointer in qedf_dbg_fp_int_cmd_read() directly https://git.kernel.org/mkp/scsi/c/25dbc20deab5
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering