Skip to contentSkip to conversation

HID: mcp2221: Fix heap buffer overflow in mcp2221_raw_event()

PATCH In review Benoit Sevens 2 participants 4 messages Apr 15 – May 13

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

PATCH 1/1 HID: mcp2221: Fix heap buffer overflow in mcp2221_raw_event()

From: Benoît Sevens <[email protected]>

A heap buffer overflow can occur in the mcp2221_raw_event() function when handling I2C read responses. The driver failed to check if the total incoming data length fits within the originally allocated buffer mcp->rxbuf.

Fix this by introducing rxbuf_len to struct mcp2221 to keep track of the allocated buffer size. Initialize it in mcp_i2c_smbus_read() and mcp_smbus_xfer(), and ensure the copied data length combined with the current index does not exceed this length in mcp2221_raw_event().

---
 drivers/hid/hid-mcp2221.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
drivers/hid/hid-mcp2221.c +8 -1
index ef3b5c77c38e..744561e65079 100644
@@ -119,6 +119,7 @@ struct mcp2221 {
 	struct completion wait_in_report;
 	struct delayed_work init_work;
 	u8 *rxbuf;
+	int rxbuf_len;
 	u8 txbuf[64];
 	int rxbuf_idx;
 	int status;
@@ -323,12 +324,14 @@ static int mcp_i2c_smbus_read(struct mcp2221 *mcp,
 		mcp->txbuf[3] = (u8)(msg->addr << 1);
 		total_len = msg->len;
 		mcp->rxbuf = msg->buf;
+		mcp->rxbuf_len = msg->len;
 	} else {
 		mcp->txbuf[1] = smbus_len;
 		mcp->txbuf[2] = 0;
 		mcp->txbuf[3] = (u8)(smbus_addr << 1);
 		total_len = smbus_len;
 		mcp->rxbuf = smbus_buf;
+		mcp->rxbuf_len = smbus_len;
 	}
 
 	ret = mcp_send_data_req_status(mcp, mcp->txbuf, 4);
@@ -538,6 +541,7 @@ static int mcp_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 
 			mcp->rxbuf_idx = 0;
 			mcp->rxbuf = data->block;
+			mcp->rxbuf_len = sizeof(data->block);
 			mcp->txbuf[0] = MCP2221_I2C_GET_DATA;
 			ret = mcp_send_data_req_status(mcp, mcp->txbuf, 1);
 			if (ret)
@@ -561,6 +565,7 @@ static int mcp_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
 
 			mcp->rxbuf_idx = 0;
 			mcp->rxbuf = data->block;
+			mcp->rxbuf_len = sizeof(data->block);
 			mcp->txbuf[0] = MCP2221_I2C_GET_DATA;
 			ret = mcp_send_data_req_status(mcp, mcp->txbuf, 1);
 			if (ret)
@@ -908,7 +913,9 @@ static int mcp2221_raw_event(struct hid_device *hdev,
 			}
 			if (data[2] == MCP2221_I2C_READ_COMPL ||
 			    data[2] == MCP2221_I2C_READ_PARTIAL) {
-				if (!mcp->rxbuf || mcp->rxbuf_idx < 0 || data[3] > 60) {
+				if (!mcp->rxbuf || mcp->rxbuf_idx < 0 ||
+				    data[3] > 60 ||
+				    mcp->rxbuf_idx + data[3] > mcp->rxbuf_len) {
 					mcp->status = -EINVAL;
 					break;
 				}
Signature · 1 line
2.54.0.rc0.605.g598a273b03-goog
#1 lore raw

Hi,

Just checking in to see if anyone had a chance to look at this patch, or if there is any feedback I can address.

Thanks!

maintainer
#2 lore raw
In reply to Benoit Sevens
Quoted 7 lines · Benoit Sevens

From: Benoît Sevens <[email protected]>

A heap buffer overflow can occur in the mcp2221_raw_event() function when handling I2C read responses. The driver failed to check if the total incoming data length fits within the originally allocated buffer mcp->rxbuf.

Quoted 6 lines

Fix this by introducing rxbuf_len to struct mcp2221 to keep track of the allocated buffer size. Initialize it in mcp_i2c_smbus_read() and mcp_smbus_xfer(), and ensure the copied data length combined with the current index does not exceed this length in mcp2221_raw_event().

Unfortunately the patch seems to have been somehow mangled by your mail client:

patching file drivers/hid/hid-mcp2221.c Hunk #1 succeeded at 126 (offset 7 lines). Hunk #2 FAILED at 324.
patch: **** malformed patch at line 173: u16 addr,

Fix for the same issue has later been submitted by Florian Pradines [1], so I will be taking that one and adding you as Reported-by: or so, ok?

Thanks.

[1] https://lore.kernel.org/all/[email protected]/

Signature · 2 lines
Jiri Kosina
SUSE Labs
#3 lore raw
Quoted 28 lines · Jiri Kosina
Quoted 7 lines · Benoit Sevens

From: Benoît Sevens <[email protected]>

A heap buffer overflow can occur in the mcp2221_raw_event() function when handling I2C read responses. The driver failed to check if the total incoming data length fits within the originally allocated buffer mcp->rxbuf.

Quoted 6 lines

Fix this by introducing rxbuf_len to struct mcp2221 to keep track of the allocated buffer size. Initialize it in mcp_i2c_smbus_read() and mcp_smbus_xfer(), and ensure the copied data length combined with the current index does not exceed this length in mcp2221_raw_event().

Unfortunately the patch seems to have been somehow mangled by your mail client:

patching file drivers/hid/hid-mcp2221.c Hunk #1 succeeded at 126 (offset 7 lines). Hunk #2 FAILED at 324.
patch: **** malformed patch at line 173: u16 addr,

Fix for the same issue has later been submitted by Florian Pradines [1], so I will be taking that one and adding you as Reported-by: or so, ok?

Quoted 8 lines

Thanks.

[1] https://lore.kernel.org/all/[email protected]/

--
Jiri Kosina
SUSE Labs

Hi Jiri,

That sounds good to me. Thanks for adding me in the Reported-by

One thing though: Florian's patch doesn't set mcp->rxbuf_size in all places. I believe it should be set in every place where mcp->rxbuf is set. There are 2 places in mcp_smbus_xfer where it is missing (see my original patch):

```c
@@ -538,6 +541,7 @@ static int mcp_smbus_xfer(struct i2c_adapter
*adapter, u16 addr,

                        mcp->rxbuf_idx = 0;
                        mcp->rxbuf = data->block;
+                       mcp->rxbuf_size = sizeof(data->block);
                        mcp->txbuf[0] = MCP2221_I2C_GET_DATA;
                        ret = mcp_send_data_req_status(mcp, mcp->txbuf, 1);
                        if (ret)
@@ -561,6 +565,7 @@ static int mcp_smbus_xfer(struct i2c_adapter
*adapter, u16 addr,

                        mcp->rxbuf_idx = 0;
                        mcp->rxbuf = data->block;
+                       mcp->rxbuf_size = sizeof(data->block);
                        mcp->txbuf[0] = MCP2221_I2C_GET_DATA;
                        ret = mcp_send_data_req_status(mcp, mcp->txbuf, 1);
                        if (ret)
```

Thanks,

Benoit